wownero-python/README.rst

90 lines
2.7 KiB
ReStructuredText
Raw Normal View History

2018-01-28 14:53:52 +00:00
Python Monero module
====================
|travis|_ |coveralls|_
2019-03-11 20:33:21 +00:00
.. |travis| image:: https://travis-ci.org/monero-ecosystem/monero-python.svg
.. _travis: https://travis-ci.org/monero-ecosystem/monero-python
2019-03-11 20:33:21 +00:00
.. |coveralls| image:: https://coveralls.io/repos/github/monero-ecosystem/monero-python/badge.svg
.. _coveralls: https://coveralls.io/github/monero-ecosystem/monero-python
2018-01-28 14:53:52 +00:00
A comprehensive Python module for handling Monero cryptocurrency.
2020-01-14 09:34:03 +00:00
* release 0.7
2019-03-11 20:33:21 +00:00
* open source: https://github.com/monero-ecosystem/monero-python
2019-11-08 09:37:40 +00:00
* works with Monero 0.13.x and `the latest source`_ (at least we try to keep up)
2018-02-18 20:29:30 +00:00
* Python 2.x and 3.x compatible
* available on PyPi: https://pypi.org/project/monero/
2018-02-18 20:29:30 +00:00
* comes with `documentation`_
* generously funded by `Monero FFS`_ donors
.. warning:: With release 0.6 the project name at PyPi has changed from `monero-python` to `monero`.
Please update your dependency files.
2018-02-18 20:29:30 +00:00
.. _`the latest source`: https://github.com/monero-project/monero
.. _`documentation`: http://monero-python.readthedocs.io/en/latest/
.. _`Monero FFS`: https://forum.getmonero.org/9/work-in-progress
2018-02-13 19:37:29 +00:00
2018-01-28 14:53:52 +00:00
Copyrights
----------
Released under the BSD 3-Clause License. See `LICENSE.txt`_.
2018-10-18 21:56:31 +00:00
Copyright (c) 2017-2018 Michał Sałaban <michal@salaban.info> and Contributors: `lalanza808`_, `cryptochangements34`_, `atward`_, `rooterkyberian`_, `brucexiu`_,
2019-01-31 10:17:44 +00:00
`lialsoftlab`_, `moneroexamples`_.
2018-01-28 14:53:52 +00:00
Copyright (c) 2016 The MoneroPy Developers (``monero/base58.py`` taken from `MoneroPy`_)
Copyright (c) 2011-2013 `pyca/ed25519`_ Developers (``monero/ed25519.py``)
2018-03-15 23:28:31 +00:00
Copyright (c) 2011 thomasv@gitorious (``monero/seed.py`` based on `Electrum`_)
2018-01-28 14:53:52 +00:00
.. _`LICENSE.txt`: LICENSE.txt
.. _`MoneroPy`: https://github.com/bigreddmachine/MoneroPy
.. _`pyca/ed25519`: https://github.com/pyca/ed25519
2018-03-15 23:28:31 +00:00
.. _`Electrum`: https://github.com/spesmilo/electrum
.. _`lalanza808`: https://github.com/lalanza808
.. _`cryptochangements34`: https://github.com/cryptochangements34
2018-06-04 10:42:21 +00:00
.. _`atward`: https://github.com/atward
2018-06-06 12:12:49 +00:00
.. _`rooterkyberian`: https://github.com/rooterkyberian
2018-07-06 13:03:58 +00:00
.. _`brucexiu`: https://github.com/brucexiu
2018-10-18 21:54:08 +00:00
.. _`lialsoftlab`: https://github.com/lialsoftlab
2019-01-31 10:17:44 +00:00
.. _`moneroexamples`: https://github.com/moneroexamples
2018-03-07 21:56:40 +00:00
Want to help?
-------------
If you find this project useful, please consider a donation to the following address:
``481SgRxo8hwBCY4z6r88JrN5X8JFCJYuJUDuJXGybTwaVKyoJPKoGj3hQRAEGgQTdmV1xH1URdnHkJv6He5WkEbq6iKhr94``
Development
-----------
1. Clone the repo
2. Create virtualenv & activate it
.. code-block:: bash
2018-06-29 18:41:23 +00:00
python3 -m venv .venv
source .venv/bin/activate
3. Install dependencies
.. code-block:: bash
pip install -r requirements.txt -r test_requirements.txt
4. Do your thing
5. Run tests
.. code-block:: bash
pytest