Python Monero module

|travis|_ |coveralls|_

.. |travis| image:: https://travis-ci.org/monero-ecosystem/monero-python.svg .. _travis: https://travis-ci.org/monero-ecosystem/monero-python

.. |coveralls| image:: https://coveralls.io/repos/github/monero-ecosystem/monero-python/badge.svg .. _coveralls: https://coveralls.io/github/monero-ecosystem/monero-python

.. warning:: URGENT SECURITY UPDATE The version 1.0.2 contains an urgent security update in the output recognition code. If you're using the module for scanning transactions and identifying outputs using the secret view key, UPDATE THE SOFTWARE IMMEDIATELY. Otherwise you're safe. Standard wallet operations like receiving payments, spending, address generation etc. are NOT AFFECTED.

A comprehensive Python module for handling Monero cryptocurrency.

• release 1.0.3
• open source: https://github.com/monero-ecosystem/monero-python
• works with Monero 0.17.x and the latest source_ (at least we try to keep up)
• Python 2.x and 3.x compatible
• available on PyPi: https://pypi.org/project/monero/
• 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.

.. _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

Copyrights

Released under the BSD 3-Clause License. See LICENSE.txt_.

Copyright (c) 2017-2018 Michał Sałaban [email protected] and Contributors: lalanza808, cryptochangements34, atward, rooterkyberian, brucexiu, lialsoftlab, moneroexamples, massanchik, MrClottom, jeffro256, sometato, kayabaNerve, j-berman_.

Copyright (c) 2016 The MoneroPy Developers (monero/base58.py taken from MoneroPy_)

Copyright (c) 2011 thomasv@gitorious (monero/seed.py based on Electrum_)

.. _LICENSE.txt: LICENSE.txt .. _MoneroPy: https://github.com/bigreddmachine/MoneroPy .. _Electrum: https://github.com/spesmilo/electrum

.. _lalanza808: https://github.com/lalanza808 .. _cryptochangements34: https://github.com/cryptochangements34 .. _atward: https://github.com/atward .. _rooterkyberian: https://github.com/rooterkyberian .. _brucexiu: https://github.com/brucexiu .. _lialsoftlab: https://github.com/lialsoftlab .. _moneroexamples: https://github.com/moneroexamples .. _massanchik: https://github.com/massanchik .. _MrClottom: https://github.com/MrClottom .. _jeffro256: https://github.com/jeffro256 .. _sometato: https://github.com/sometato .. _kayabaNerve: https://github.com/kayabaNerve .. _j-berman: https://github.com/j-berman

Want to help?

If you find this project useful, please consider a donation to the following address: 8AWCa5moRywJcmA6jqnKLJWZMUyoEAFJXBqqDonUnR1SjS8foScqTadcXyE6oVb6Mh2JFeWZtocGxZoZZsMqLNKbNm5Wt3q

Development

1. Clone the repo
2. Create virtualenv & activate it

.. code-block:: bash

python3 -m venv .venv
source .venv/bin/activate

3. Install dependencies

.. code-block:: bash

.venv/bin/pip install -r requirements.txt -r test_requirements.txt

4. Do your thing

5. Run tests

.. code-block:: bash

.venv/bin/pytest

6. Format your code with black

.. code-block:: bash

.venv/bin/black .