Metadata-Version: 2.1
Name: Misskey.py
Version: 3.0.0
Summary: The Misskey library for Python. Misskey is made by syuilo.
Home-page: https://github.com/YuzuRyo61/Misskey.py
Author: YuzuRyo61
Author-email: UNKNOWN
License: MIT
Keywords: Misskey API syuilo
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Japanese
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet
Requires-Dist: requests


Misskey.py
==========


.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
   :target: http://makeapullrequest.com
   :alt: PRs Welcome


.. image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
   :target: LICENSE
   :alt: MIT License


.. image:: https://travis-ci.org/YuzuRyo61/Misskey.py.svg?branch=v1
   :target: https://travis-ci.org/YuzuRyo61/Misskey.py
   :alt: Build Status


.. image:: https://coveralls.io/repos/github/YuzuRyo61/Misskey.py/badge.svg?branch=v1
   :target: https://coveralls.io/github/YuzuRyo61/Misskey.py?branch=v1
   :alt: Coverage Status


.. image:: https://readthedocs.org/projects/misskeypy/badge/?version=latest
   :target: https://misskeypy.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status


..

   Japanese version available. `Click Here <https://github.com/YuzuRyo61/Misskey.py/blob/v2/README-JP.md>`_.


This script is Python library for Misskey Instance.

This library is only available in Python3.

`Misskey <https://github.com/syuilo/misskey>`_ is made by `syuilo <https://github.com/syuilo>`_.

----

How to install
--------------

Use pip (Recommend)
^^^^^^^^^^^^^^^^^^^

.. code-block:: bash

   pip install Misskey.py
   # or
   pip3 install Misskey.py

usage
-----

import library (init)
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: python

   from Misskey import Misskey

   misskey = Misskey("misskey.io") # Input instance address (If leaved no attribute, it sets "misskey.io")

Use token key
~~~~~~~~~~~~~

.. code-block:: python

   from Misskey import Misskey

   # If use the token
   misskey = Misskey("misskey.io", i="abcdef123...")

Create token
^^^^^^^^^^^^

.. code-block:: python

   from Misskey import Misskey
   from Misskey.Util import MiAuth

   auth = MiAuth("misskey.io", name="Misskey.py")
   # Get Authentication URL, then send to client browser
   url = auth.getUrl()
   # After permission granted, run this function
   token = auth.check()
   # To use Misskey.py with created token, please below
   misskey = Misskey("misskey.io", i=token["token"]) # or: misskey = Misskey("misskey.io", i=auth.token)

Other
-----

**Pull requests are HUGE WELCOME!**

We hope you will contribute to the completion of the library by all means.


