Python package for Parity's Secret Store API calls and sessions.
Project description
Secret Store python package
This is a python library for interacting with Parity's secret store. It is an abstraction layer (API) on top of the official secretstore module RPC API and secretstore sessions. Naming conventions follow the underlying APIs'.
The documentation is for this library and its functions. For more information on how Secret Store works, please refer to the Parity wiki. Most of the function descriptions have been copied from there.
Maintainers
Primary: Adam Nagy (@ngyam)
Documentation
Readthedocs: https://secretstore.readthedocs.io/index.html
Quickstart
pip install secretstore
Then in your project:
from web3 import Web3, HTTPProvider
from secretstore import SecretStore
web3 = Web3(HTTPProvider("http://127.0.0.1:8545"))
# endpoint exposed by your Secret Store
ss = SecretStore(web3, "http://127.0.0.1:8090")
# secretstore API calls
ss.something..
# secretstore session calls
ss.session.something..
If you wonder how to set up a Secret Store cluster, check out the official config guide and peek into the nodes_ss_dev/ folder.
Examples
You can see some examples amongst the tests.
Contributing
Please read contributing and our code of conduct for details.
Getting started (as a dev)
Prerequisites
- Python 3.5+
Installing
git clone https://github.com/energywebfoundation/secretstore-py.git
pip install -e .[dev]
Running the tests
ACHTUNG: make sure to start the local secret store cluster first.
- start nodes
cd nodes_ss_dev
./start.sh
- run tests
cd tests
python3 -m unittest
- When done fiddling around:
cd nodes_ss_dev && ./stop.sh
Versioning
We use SemVer for versioning. Version number is bumped with bumpversion
tool.
License
This project is licensed under the GPLv3 License - see the LICENSE file for details.
Acknowledgments
- Special thanks to Parity
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 Distribution
Built Distribution
Hashes for secretstore-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 657303508ae49f564dcee49ff688a331ae3c0ca237cfc9ac3a6e8fe0585d7404 |
|
MD5 | 66bb1f43ed231a9bdaaf50184ed7da25 |
|
BLAKE2b-256 | fd996b22a26d4132f8be1c44781662f5b9e1069cf3d556d22814569e0e9ecf18 |