Asynchronously your acquaintances from GitHub issues
Project description
Asya
====
|license|
**AS**\ ynchronously-\ **Y**\ our-\ **A**\ cquaintances from `GitHub`_ issues
Installation
------------
You can simply install Asya in standard Python way (system-wide or with virtual env).
Python 3.4 or higher is required (`asyncio`_ is in Python since 3.4).
.. code::
python setup.py install
Usage
-----
After installation, you can use the CLI of Asya (for more, visit :ref:`CLI docs <cli-docs>`):
.. code::
asya --help
asya MarekSuchanek --token <your-secret-API-token>
Documentation
-------------
After installing Asya, you can also build the documentation:
.. code::
cd docs
pip install -r requirements.txt
make html
Then open `docs/_build/html/index.html` in your browser. For more information visit
`Sphinx documentation`_.
License
-------
This project is licensed under the MIT License - see the `LICENSE`_ file for more details.
.. _LICENSE: LICENSE
.. _GitHub: https://github.com
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _Sphinx documentation: http://www.sphinx-doc.org/en/stable/
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: License
:target: LICENSE
====
|license|
**AS**\ ynchronously-\ **Y**\ our-\ **A**\ cquaintances from `GitHub`_ issues
Installation
------------
You can simply install Asya in standard Python way (system-wide or with virtual env).
Python 3.4 or higher is required (`asyncio`_ is in Python since 3.4).
.. code::
python setup.py install
Usage
-----
After installation, you can use the CLI of Asya (for more, visit :ref:`CLI docs <cli-docs>`):
.. code::
asya --help
asya MarekSuchanek --token <your-secret-API-token>
Documentation
-------------
After installing Asya, you can also build the documentation:
.. code::
cd docs
pip install -r requirements.txt
make html
Then open `docs/_build/html/index.html` in your browser. For more information visit
`Sphinx documentation`_.
License
-------
This project is licensed under the MIT License - see the `LICENSE`_ file for more details.
.. _LICENSE: LICENSE
.. _GitHub: https://github.com
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _Sphinx documentation: http://www.sphinx-doc.org/en/stable/
.. |license| image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: License
:target: LICENSE
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
asya-0.0.tar.gz
(11.0 kB
view hashes)