ambethia/neo-python-core

Core functionality of neo-python

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

• Includes datatypes like UInt160, KeyPair, and basic string to address and address to UInt160 methods.
• Used by neo-python.
• https://pypi.python.org/pypi/neocore

Currently in alpha development.

Getting started

You need Python 3.5.

You can install neocore from PyPI with easy_install or pip:

$ 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:

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

• Then install the requirements:

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

Useful commands

$ 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:

# 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