beem - Unofficial Python Library for HIVE and STEEM
===================================================
beem is an unofficial python library for steem and HIVE, which is created new from scratch from `python-bitshares`_
The library name is derived from a beam machine, similar to the analogy between steem and steam. beem includes `python-graphenelib`_.
.. image:: https://img.shields.io/pypi/v/beem.svg
:target: https://pypi.python.org/pypi/beem/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/pyversions/beem.svg
:target: https://pypi.python.org/pypi/beem/
:alt: Python Versions
.. image:: https://anaconda.org/conda-forge/beem/badges/version.svg
:target: https://anaconda.org/conda-forge/beem
.. image:: https://anaconda.org/conda-forge/beem/badges/downloads.svg
:target: https://anaconda.org/conda-forge/beem
.. image:: https://repl.it/badge/github/holgern/beem
:target: https://repl.it/github/holgern/beem
:alt: Run on Repl.it
Current build status
--------------------
.. image:: https://travis-ci.org/holgern/beem.svg?branch=master
:target: https://travis-ci.org/holgern/beem
.. image:: https://ci.appveyor.com/api/projects/status/ig8oqp8bt2fmr09a?svg=true
:target: https://ci.appveyor.com/project/holger80/beem
.. image:: https://circleci.com/gh/holgern/beem.svg?style=svg
:target: https://circleci.com/gh/holgern/beem
.. image:: https://readthedocs.org/projects/beem/badge/?version=latest
:target: http://beem.readthedocs.org/en/latest/?badge=latest
.. image:: https://api.codacy.com/project/badge/Grade/e5476faf97df4c658697b8e7a7efebd7
:target: https://www.codacy.com/app/holgern/beem?utm_source=github.com&utm_medium=referral&utm_content=holgern/beem&utm_campaign=Badge_Grade
.. image:: https://pyup.io/repos/github/holgern/beem/shield.svg
:target: https://pyup.io/repos/github/holgern/beem/
:alt: Updates
.. image:: https://api.codeclimate.com/v1/badges/e7bdb5b4aa7ab160a780/test_coverage
:target: https://codeclimate.com/github/holgern/beem/test_coverage
:alt: Test Coverage
Support & Documentation
=======================
You may find help in the `beem-discord-channel`_. The discord channel can also be used to discuss things about beem.
A complete library documentation is available at `beem.readthedocs.io`_.
About beem
==========
* High unit test coverage
* Support for websocket nodes
* Native support for new Appbase calls
* Node error handling and automatic node switching
* Usage of pycryptodomex instead of the outdated pycrypto
* Complete documentation of beempy and all classes including all functions
* hivesigner integration
* Works on read-only systems
* Own BlockchainObject class with cache
* Contains all broadcast operations
* Estimation of virtual account operation index from date or block number
* the command line tool beempy uses click and has more commands
* NodeRPC can be used to execute even not implemented RPC-Calls
* More complete implemention
Installation
============
The minimal working python version is 3.6.x
beem can be installed parallel to python-steem.
For Debian and Ubuntu, please ensure that the following packages are installed:
.. code:: bash
sudo apt-get install build-essential libssl-dev python3-dev python3-pip python3-setuptools
The following package speeds up beempy:
.. code:: bash
sudo apt-get install python3-gmpy2
For Fedora and RHEL-derivatives, please ensure that the following packages are installed:
.. code:: bash
sudo yum install gcc openssl-devel python-devel
For OSX, please do the following::
brew install openssl
export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"
export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"
For Termux on Android, please install the following packages:
.. code:: bash
pkg install clang openssl python
Signing and Verify can be fasten (200 %) by installing cryptography (you may need to replace pip3 by pip):
.. code:: bash
pip3 install -U cryptography
or (you may need to replace pip3 by pip):
.. code:: bash
pip3 install -U secp256k1prp
Install or update beem by pip(you may need to replace pip3 by pip)::
pip3 install -U beem
You can install beem from this repository if you want the latest
but possibly non-compiling version::
git clone https://github.com/holgern/beem.git
cd beem
python3 setup.py build
python3 setup.py install --user
Run tests after install::
pytest
Installing beem with conda-forge
--------------------------------
Installing beem from the conda-forge channel can be achieved by adding conda-forge to your channels with::
conda config --add channels conda-forge
Once the conda-forge channel has been enabled, beem can be installed with::
conda install beem
Signing and Verify can be fasten (200 %) by installing cryptography::
conda install cryptography
beem can be updated by::
conda update beem
CLI tool beempy
---------------
A command line tool is available. The help output shows the available commands:
beempy --help
Ledger support
--------------
For Ledger (Nano S) signing, the following package must be installed:
pip3 install ledgerblue
Stand alone version of CLI tool beempy
--------------------------------------
With the help of pyinstaller, a stand alone version of beempy was created for Windows, OSX and linux.
Each version has just to be unpacked and can be used in any terminal. The packed directories
can be found under release. Each release has a hash sum, which is created directly in the build-server
before transmitting the packed file. Please check the hash-sum after downloading.
Changelog
=========
Can be found in CHANGELOG.rst.
License
=======
This library is licensed under the MIT License.
Acknowledgements
================
`python-bitshares`_ and `python-graphenelib`_ were created by Fabian Schuh (xeroc).
.. _python-graphenelib: https://github.com/xeroc/python-graphenelib
.. _python-bitshares: https://github.com/xeroc/python-bitshares
.. _Python: http://python.org
.. _Anaconda: https://www.continuum.io
.. _beem.readthedocs.io: http://beem.readthedocs.io/en/latest/
.. _beem-discord-channel: https://discord.gg/4HM592V
Raw data
{
"_id": null,
"home_page": "https://github.com/Damurq/beem/",
"name": "beem-witness-library",
"maintainer": "Holger Nahrstaedt",
"docs_url": null,
"requires_python": "",
"maintainer_email": "nahrstaedt@gmail.com",
"keywords": "hive,steem,library,api,rpc",
"author": "Holger Nahrstaedt",
"author_email": "nahrstaedt@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/55/d4/fdb969acb52539a6508701b977507bf271f8ac2293d8fdaf0003fb8d4e19/beem-witness-library-0.24.32.tar.gz",
"platform": null,
"description": "beem - Unofficial Python Library for HIVE and STEEM\r\n===================================================\r\n\r\nbeem is an unofficial python library for steem and HIVE, which is created new from scratch from `python-bitshares`_\r\nThe library name is derived from a beam machine, similar to the analogy between steem and steam. beem includes `python-graphenelib`_.\r\n\r\n.. image:: https://img.shields.io/pypi/v/beem.svg\r\n :target: https://pypi.python.org/pypi/beem/\r\n :alt: Latest Version\r\n\r\n.. image:: https://img.shields.io/pypi/pyversions/beem.svg\r\n :target: https://pypi.python.org/pypi/beem/\r\n :alt: Python Versions\r\n\r\n\r\n.. image:: https://anaconda.org/conda-forge/beem/badges/version.svg\r\n :target: https://anaconda.org/conda-forge/beem\r\n\r\n\r\n.. image:: https://anaconda.org/conda-forge/beem/badges/downloads.svg\r\n :target: https://anaconda.org/conda-forge/beem\r\n\r\n\r\n.. image:: https://repl.it/badge/github/holgern/beem\r\n :target: https://repl.it/github/holgern/beem\r\n :alt: Run on Repl.it\r\n\r\nCurrent build status\r\n--------------------\r\n\r\n.. image:: https://travis-ci.org/holgern/beem.svg?branch=master\r\n :target: https://travis-ci.org/holgern/beem\r\n\r\n.. image:: https://ci.appveyor.com/api/projects/status/ig8oqp8bt2fmr09a?svg=true\r\n :target: https://ci.appveyor.com/project/holger80/beem\r\n\r\n.. image:: https://circleci.com/gh/holgern/beem.svg?style=svg\r\n :target: https://circleci.com/gh/holgern/beem\r\n\r\n.. image:: https://readthedocs.org/projects/beem/badge/?version=latest\r\n :target: http://beem.readthedocs.org/en/latest/?badge=latest\r\n\r\n.. image:: https://api.codacy.com/project/badge/Grade/e5476faf97df4c658697b8e7a7efebd7\r\n :target: https://www.codacy.com/app/holgern/beem?utm_source=github.com&utm_medium=referral&utm_content=holgern/beem&utm_campaign=Badge_Grade\r\n\r\n.. image:: https://pyup.io/repos/github/holgern/beem/shield.svg\r\n :target: https://pyup.io/repos/github/holgern/beem/\r\n :alt: Updates\r\n\r\n.. image:: https://api.codeclimate.com/v1/badges/e7bdb5b4aa7ab160a780/test_coverage\r\n :target: https://codeclimate.com/github/holgern/beem/test_coverage\r\n :alt: Test Coverage\r\n\r\nSupport & Documentation\r\n=======================\r\nYou may find help in the `beem-discord-channel`_. The discord channel can also be used to discuss things about beem.\r\n\r\nA complete library documentation is available at `beem.readthedocs.io`_.\r\n\r\nAbout beem\r\n==========\r\n\r\n* High unit test coverage\r\n* Support for websocket nodes\r\n* Native support for new Appbase calls\r\n* Node error handling and automatic node switching\r\n* Usage of pycryptodomex instead of the outdated pycrypto\r\n* Complete documentation of beempy and all classes including all functions\r\n* hivesigner integration\r\n* Works on read-only systems\r\n* Own BlockchainObject class with cache\r\n* Contains all broadcast operations\r\n* Estimation of virtual account operation index from date or block number\r\n* the command line tool beempy uses click and has more commands\r\n* NodeRPC can be used to execute even not implemented RPC-Calls\r\n* More complete implemention\r\n\r\nInstallation\r\n============\r\nThe minimal working python version is 3.6.x\r\n\r\nbeem can be installed parallel to python-steem.\r\n\r\nFor Debian and Ubuntu, please ensure that the following packages are installed:\r\n\r\n.. code:: bash\r\n\r\n sudo apt-get install build-essential libssl-dev python3-dev python3-pip python3-setuptools\r\n\r\nThe following package speeds up beempy:\r\n.. code:: bash\r\n\r\n sudo apt-get install python3-gmpy2\r\n\r\nFor Fedora and RHEL-derivatives, please ensure that the following packages are installed:\r\n\r\n.. code:: bash\r\n\r\n sudo yum install gcc openssl-devel python-devel\r\n\r\nFor OSX, please do the following::\r\n\r\n brew install openssl\r\n export CFLAGS=\"-I$(brew --prefix openssl)/include $CFLAGS\"\r\n export LDFLAGS=\"-L$(brew --prefix openssl)/lib $LDFLAGS\"\r\n\r\nFor Termux on Android, please install the following packages:\r\n\r\n.. code:: bash\r\n\r\n pkg install clang openssl python\r\n\r\nSigning and Verify can be fasten (200 %) by installing cryptography (you may need to replace pip3 by pip):\r\n\r\n.. code:: bash\r\n\r\n pip3 install -U cryptography\r\n\r\nor (you may need to replace pip3 by pip):\r\n\r\n.. code:: bash\r\n\r\n pip3 install -U secp256k1prp\r\n\r\nInstall or update beem by pip(you may need to replace pip3 by pip)::\r\n\r\n pip3 install -U beem\r\n\r\nYou can install beem from this repository if you want the latest\r\nbut possibly non-compiling version::\r\n\r\n git clone https://github.com/holgern/beem.git\r\n cd beem\r\n python3 setup.py build\r\n\r\n python3 setup.py install --user\r\n\r\nRun tests after install::\r\n\r\n pytest\r\n\r\n\r\nInstalling beem with conda-forge\r\n--------------------------------\r\n\r\nInstalling beem from the conda-forge channel can be achieved by adding conda-forge to your channels with::\r\n\r\n conda config --add channels conda-forge\r\n\r\nOnce the conda-forge channel has been enabled, beem can be installed with::\r\n\r\n conda install beem\r\n\r\nSigning and Verify can be fasten (200 %) by installing cryptography::\r\n\r\n conda install cryptography\r\n\r\nbeem can be updated by::\r\n\r\n conda update beem\r\n\r\nCLI tool beempy\r\n---------------\r\nA command line tool is available. The help output shows the available commands:\r\n\r\n beempy --help\r\n\r\nLedger support\r\n--------------\r\nFor Ledger (Nano S) signing, the following package must be installed:\r\n\r\n pip3 install ledgerblue\r\n\r\nStand alone version of CLI tool beempy\r\n--------------------------------------\r\nWith the help of pyinstaller, a stand alone version of beempy was created for Windows, OSX and linux.\r\nEach version has just to be unpacked and can be used in any terminal. The packed directories\r\ncan be found under release. Each release has a hash sum, which is created directly in the build-server\r\nbefore transmitting the packed file. Please check the hash-sum after downloading.\r\n\r\nChangelog\r\n=========\r\nCan be found in CHANGELOG.rst.\r\n\r\nLicense\r\n=======\r\nThis library is licensed under the MIT License.\r\n\r\nAcknowledgements\r\n================\r\n`python-bitshares`_ and `python-graphenelib`_ were created by Fabian Schuh (xeroc).\r\n\r\n\r\n.. _python-graphenelib: https://github.com/xeroc/python-graphenelib\r\n.. _python-bitshares: https://github.com/xeroc/python-bitshares\r\n.. _Python: http://python.org\r\n.. _Anaconda: https://www.continuum.io\r\n.. _beem.readthedocs.io: http://beem.readthedocs.io/en/latest/\r\n.. _beem-discord-channel: https://discord.gg/4HM592V\r\n \r\n\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Unofficial Python library for HIVE and STEEM",
"version": "0.24.32",
"split_keywords": [
"hive",
"steem",
"library",
"api",
"rpc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55d4fdb969acb52539a6508701b977507bf271f8ac2293d8fdaf0003fb8d4e19",
"md5": "b0aacb6ce41d54ae77155c28174878a3",
"sha256": "98ac891b7ca8e318325de2dfed5fa0176303f636baa02c2c2328fac1b7187bcb"
},
"downloads": -1,
"filename": "beem-witness-library-0.24.32.tar.gz",
"has_sig": false,
"md5_digest": "b0aacb6ce41d54ae77155c28174878a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 572814,
"upload_time": "2023-03-23T17:29:59",
"upload_time_iso_8601": "2023-03-23T17:29:59.244291Z",
"url": "https://files.pythonhosted.org/packages/55/d4/fdb969acb52539a6508701b977507bf271f8ac2293d8fdaf0003fb8d4e19/beem-witness-library-0.24.32.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-23 17:29:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Damurq",
"github_project": "beem",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"circle": true,
"appveyor": true,
"tox": true,
"lcname": "beem-witness-library"
}
JSON
