Metadata-Version: 1.1
Name: PyNekos
Version: 1
Summary: Python client for the https://nekos.moe/ API
Home-page: https://github.com/ChoiYun/PyNekos
Author: Pedro Huang
Author-email: justhuangpedro@gmail.com
License: MIT
Download-URL: https://github.com/ChoiYun/PyNekos/archive/v1.tar.gz
Description: 
        # PyNekos: a Python client for the Nekos.moe API 
        `PyNekos` provides a simple and pythonic way to use the [Nekos.moe API](https://docs.nekos.moe/).
        
        The full documentation for `PyNekos` can be found [here](https://github.com/ChoiYun/PyNekos/blob/main/docs/doc.md).
        
        ## Setup
        Some functionalities of the API needs authentication, used for post images and regenerate and get token. This way, if you pretend to use this functionalities, you'll need to sign up for a (free) account that authorizes access to the Nekos.moe API. If you pretend to use only the simple functionalities (like get images informations, user informations, search for images, etc), you don't need to pass nothing to the Neko class, see [usage](https://github.com/ChoiYun/PyNekos#usage) section below.
        
        
        ## Installation
        `PyNekos` requires Python 3.
        
        Use `pip` to install the package from PyPI:
        
        ```bash
        pip install PyNekos
        ```
        
        
        ## Usage
        Import the package and initiate the Neko class:
        
        ```python
        from PyNekos.nekosapi import Neko
        nyan = Neko()
        ```
        
        If you pretend to use more advanced functionalities of the API, you'll need the token. To get the token, you'll need your credentials: 
        
        ```python
        from PyNekos.nekosapi import Neko
        nyan = Neko(username='myuser', password='iwillnotshowyouthis')
        token = nyan.get_token()
        print(token)
        ```
        
        After that, instance the object again with all informations:
        
        ```python
        from PyNekos.nekosapi import Neko
        nyan = Neko(token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", username="myuser", password="iwillnotshowyouthis")
        ```
        
        ## Examples
        You can see the usage of all endpoints of the API in the [example files](https://github.com/ChoiYun/PyNekos/tree/main/examples).
        
        
        ## Contributing
        Please contribute! If you want to fix a bug, suggest improvements, or add new features to the project, just [open an issue](https://github.com/ChoiYun/PyNekos/issues) or send a pull request.
        
Keywords: Nekos.moe,Neko,Nekos API
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
