Ethereum -- Next generation cryptocurrency network
Ethereum Python Client
Quickstart
Installation:
- Python2.7 is required
pip install -r requirements.txt
That will try to install the requirements in your current environment.
NOTE: If you have not setup a virtualenv this will most likely try to install dependencies globally and might require more privileges.
In case you want to avoid messing with your global environment, you can use Buildout (optional).
Run the client:
pyethereum/eth.py -r 54.204.10.41
For developers
How to contribute
We accept pull requests. Fork the repository and send your PR!
dev_requirements
To install the dependencies necessary for development (testing, ...), run:
pip install -r dev_requirements.txt
Coding
- You should write code compatible with Python3.
- Your code should pass PEP8 check.
Testing
In order to run tests, you need to prepare the fixtures
-submodule
(not necessary when using bootstrap):
git submodule init git submodule update --recursive
then run the tests either by calling
behave
and py.test
consecutively or by calling tox
(which will do both).
In order to update the fixtures
-submodule:
git submodule status cd fixtures/ git pull origin develop cd .. git commit -m 'updated fixtures submodule'
Tips for writing test code for behave
- write test scenario in xxx.feature
- run
behave
, then behave will report the newly written scenario are not implemented, and the code skeleton for the corresponding steps will also be generated. - copy & paste the generated code skeleton into a file in the steps directory and then write your test code based on it.
- if you need setup/teardown for feature/scenario with specific tag of mytag, create a file called mytag.py in the hooks directory
Tips for debug
for test specific scenario while ignoring all other ones, just add @wip in the uppper line of the scenario.
for debug, run:
$ BEHAVE_DEBUG_ON_ERROR=yes behave -w
Logging:
Please use the logging
module for logging.
For basic, verbose logging functionality, the following is sufficient (adjust level to your needs):
import logging logging.basicConfig(format='[%(asctime)s] %(name)s %(levelname)s %(message)s', level=logging.DEBUG) logger = logging.getLogger(__name__)
If you need a more advanced setup, have a look at the python docs
Easy Debugging:
The eth.py
script, understands a command line flag for easy debugging, e.g.:
pyethereum/eth.py -L pyethereum.wire:DEBUG,:INFO ...<other args>
will set the log-level for wire
to DEBUG
and the root logger to INFO
.
Buildout (optional)
You can have dependencies managed by buildout --
a buildout.cfg
is already included in the project.
Bootstrap:
In order to do so, you'll need to bootstrap the project (needs only be
done once). On systems that provide curl
you can use the following handy
one-liner (no curl ?):
curl http://downloads.buildout.org/2/bootstrap.py | python
Build and run:
Build the project via bin/buildout
and run the client via bin/eth
.
This will install dependencies in a virtualenv, provide you with a scoped python
interpreter (bin/python
) and make all console_scripts available in the
bin
directory.
develop.cfg
Instead of only running bin/buildout
, there is an extending
buildout configuration for development purposes (it will install the
dev_requirements, prepare tests, etc...). It is an executable .cfg file:
./develop.cfg
will run the extended buildout.
Hints:
console-scripts
If you follow the buildout way, some of the commands in this README will change,
since buildout installs the dependencies as well as pyethereum's console_scripts in the bin/
-directory.
For example, instead of running the cli client with:
pyethereum/eth.py # it will become bin/eth
same goes for behave
which becomes bin/behave
.
no curl
If your system has wget
and not curl
you can also use wget -O -
in place of curl
. Otherwise download the bootstrap script
into the project folder and call python bootstrap.py
. (If you get setuptools issue, try
python bootstrap.py -v 2.1.1
)
buildout default.cfg
To prevent buildout from cluttering your working directory with an eggs/
directory, you should
consider using a ~/.buildout/default.cfg
:
export "BDIR=$HOME/.buildout" mkdir -p $BDIR/eggs $BDIR/extends $BDIR/cache echo "[buildout]" >> $BDIR/default.cfg echo "eggs-directory = $BDIR/eggs" >> $BDIR/default.cfg echo "download-cache = $BDIR/cache" >> $BDIR/default.cfg echo "extends-cache = $BDIR/extends" >> $BDIR/default.cfg
After doing that, cleaning your clone with git clean -xfd
and redoing the Bootstrap part is recommended.
Licence
See LICENCE
Credits
Ethereum is based on a design by Vitalik Buterin.
Implementation of the python ethereum client is mainly done by
- Chen Houwu
- Heiko Hees
- Vitalik Buterin