Metadata-Version: 2.0
Name: neocore
Version: 0.3.2
Summary: Core functionality of neo-python
Home-page: https://github.com/CityOfZion/neo-python-core
Author: City of Zion
Author-email: python@cityofzion.io
License: MIT license
Keywords: neocore,neo,python,node
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Requires-Python: >=3.4, <3.6
Requires-Dist: logzero (==1.3.1)
Requires-Dist: ecdsa (==0.13)
Requires-Dist: base58 (==0.2.5)
Requires-Dist: bitcoin (==1.1.42)
Requires-Dist: mpmath (==1.0.0)
Requires-Dist: scrypt (==0.8.0)
Requires-Dist: pycrypto (==2.6.1)

Library for working with NEO related data in Python, without database dependencies.

.. image:: https://travis-ci.org/CityOfZion/neo-python-core.svg?branch=master
        :target: https://travis-ci.org/CityOfZion/neo-python-core

.. image:: https://coveralls.io/repos/github/CityOfZion/neo-python-core/badge.svg
        :target: https://coveralls.io/github/CityOfZion/neo-python-core


* Includes datatypes like ``UInt160``, ``KeyPair``, and basic string to address and address to ``UInt160`` methods.
* Used by `neo-python <https://github.com/CityOfZion/neo-python>`_.
* https://pypi.python.org/pypi/neocore

Currently in alpha development.


Getting started
---------------

You need `Python 3.5 <https://www.python.org/downloads/release/python-354/>`_.

You can install `neocore` from PyPI with ``easy_install`` or ``pip``:


.. code-block:: console

    $ pip install -U neocore

Alternatively, if you want to work on the code, clone this repository and setup your venv:

* Clone the repo: ``git@github.com:CityOfZion/neo-python-core.git``
* Create a Python 3 virtual environment and activate it:

.. code-block:: console

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

* Then install the requirements:

.. code-block:: console

    $ pip install -e .
    $ pip install -r requirements_dev.txt


Useful commands
^^^^^^^^^^^^^^^

.. code-block:: console

    $ make lint
    $ make test
    $ make coverage


Release checklist
^^^^^^^^^^^^^^^^^

(Only for admins)

Releasing a new version on GitHub automatically uploads this release to PyPI.
This is a checklist for releasing a new version:

.. code-block:: console

    # In case you want to increase the version number again (eg. scope changed from patch to minor):
    bumpversion --no-tag patch|minor|major

    # Update ``HISTORY.rst`` with the new version number and the changes and commit this
    vi HISTORY.rst
    git commit -m "Updated HISTORY.rst" HISTORY.rst

    # Set the release version number and create the tag
    bumpversion release

    # Increase patch number and add `-dev`
    bumpversion --no-tag patch

    # Push to GitHub, which also updates the PyPI package
    git push && git push --tags


=======
History
=======

0.3.1 (2018-01-09)
------------------
* Documentation update
* Moved the ``cryptography`` dependency to ``requirements_dev.txt``


0.3.0 (2018-01-09)
------------------
* Added ``neo.Cryptography`` and ``KeyPair``
* Changed signature of ``neocore.Cryptography.Crypto.Sign()`` to remove unused ``public_key`` argument
* Removed redundant ``neocore.Cryptography.Helper.hash_to_wallet_address()`` function, use  ``neocore.Cryptography.Helper.scripthash_to_address()`` instead.
* Removed unused ``neocore.Cryptography.Helper`` functions: ``random_string``, ``bytes_to_hex_string``, ``bin_sha256``, ``sha256``, ``random_key``.


0.2.4 + 0.2.5 (2018-01-03)
--------------------------
* Bugfix for deploying from Travis to PyPI/neocore


0.2.3 (2018-01-03)
------------------
* Bugfix for BinaryWriter (`PR #13 <https://github.com/CityOfZion/neo-python-core/pull/13>`_)


0.2.1 (2018-01-02)
------------------
* Added UInt*, Fixed8 and neo.IO.Binary* (`PR #9 <https://github.com/CityOfZion/neo-python-core/pull/9>`_)


0.1.1 - 0.1.2 (2017-12-30)
--------------------------

* Testing of releases on PyPI with Travis CI.


0.1.0 (2017-12-28)
------------------

* First release on PyPI.


