python SDK for AERGO
Project description
======
herapy
======
.. image:: https://codecov.io/gh/aergoio/herapy/branch/accounts/graph/badge.svg?token=JylbPsDrDB
:target: https://codecov.io/gh/aergoio/herapy
.. image:: https://img.shields.io/pypi/v/aergo-herapy.svg
:target: https://pypi.python.org/pypi/aergo-herapy
.. image:: https://travis-ci.com/aergoio/herapy.svg?token=bxpJA7kPFExuJMq3sBNb&branch=master
:target: https://travis-ci.com/aergoio/herapy
.. image:: https://readthedocs.org/projects/herapy/badge/?version=latest
:target: https://herapy.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/aergoio/herapy/shield.svg
:target: https://pyup.io/repos/github/aergoio/herapy/
:alt: Updates
HeraPy is a Python package for AERGO that provides the features below.
--------
Features
--------
* Communication with AERGO node
* Getting AERGO blockchain information
* Creating/Exporting/Importing an account
* Making and sending a transaction
* Deploying/Calling/Querying a smart contract
-------
Install
-------
.. code-block::
pip install aergo-herapy
or, install locally
.. code-block::
git clone git@github.com:aergoio/herapy.git
cd herapy
make install
-----
Build
-----
Downloading HeraPy
==================
Download HeraPy from this repository
.. code-block::
git clone git@github.com:aergoio/herapy.git
Installing Dependencies
=======================
.. code-block::
pip install -r requirements.txt
But, we recommend to use a virtual environment below.
Virtual Environment (Pipenv)
----------------------------
Using Pipenv, all dependencies will be installed automatically.
.. code-block::
pipenv shell
Updating Protocol
=================
If need to upgrade a protocol,
.. code-block::
make protoc
After this command, all protocol related source files will be generated if it's different.
-------------------------
Releases and Contributing
-------------------------
HeraPy follows a major release cycle of AERGO.
A minor release such as fixing bugs and errors are occasionally patched.
Please let us know if you encounter a bug by `filling an issue <https://github.com/aergoio/herapy/issues>`_.
If you are planning to contribute a new feature, class, or function,
please `open an issue <https://github.com/aergoio/herapy/issues>`_ and discuss with us.
We appreciate all contributions.
-------
License
-------
HeraPy is MIT license as found in the LICENSE file.
* Documentation: https://herapy.readthedocs.io.
-------
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.1.0 (2018-11-07)
------------------
* First release on PyPI.
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for aergo_herapy-0.1.17-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ae46829f5e71c8f219f4ba059e4583e7a5fd4b878fb2df3d34cfdc14383daa3 |
|
MD5 | a270dc3aa017716a26934c62349b13f9 |
|
BLAKE2b-256 | 16ed494853cd9af9eafb88401e5d8330755f58f364cccbedfe8183d6d19a885f |