Metadata-Version: 2.1
Name: Misskey.py
Version: 0.7.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.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet
Requires-Dist: requests
Requires-Dist: websocket-client


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


.. image:: https://circleci.com/gh/YuzuRyo61/Misskey.py.svg?style=shield
   :target: https://circleci.com/gh/YuzuRyo61/Misskey.py
   :alt: CircleCI


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


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


..

   Japanese version available. `Click Here <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.xyz") # Input instance address (If leaved no attribute, it sets "misskey.xyz")

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

.. code-block:: python

   from Misskey import Misskey

   # If use the appSecret and accessToken
   misskey = Misskey("misskey.xyz", appSecret="abcdef123...", accessToken="abcdef123...")

**or**

.. code-block:: python

   from Misskey import Misskey

   # If use the apiToken (apiToken is sha256 hashed from appSecret and accessToken)
   misskey = Misskey("misskey.xyz", apiToken="abcdef123...")

Other
=====

**Pull requests are HUGE WELCOME!**

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


