semvec/pypi-packages huggingface dataset:
PyNekos 1.41
Python client for the https://nekos.moe/ API
License: MIT
Keywords: Nekos.moe,Neko,Nekos API

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 even need to instance an object of 
the **Neko** class.

Installation
------------

``PyNekos`` requires Python 3.

Use ``pip`` to install the package from PyPI:

.. code:: bash

    pip install PyNekos

Usage
-----

Import the package and initiate the Neko class:

.. code:: 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:

.. code:: 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 the token:

.. code:: python

    from PyNekos.nekosapi import Neko
    nyan = Neko(token="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")

Examples
--------

Getting a random image:

.. code:: python

    from PyNekos.nekosapi import Neko
    random_json = Neko.random_image()
    print(random_json)
    
Getting the link of the image ID and downloading the image:

.. code:: python

    from PyNekos.nekosapi import Neko
    image_down = Neko.get_link('Sy9sHFa8X', down=True)
    print(image_down)


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.