Skip to content

NicolaCostantino/Blockchain-Internals

Repository files navigation

Build Status codecov

Blockchain-Internals

Proofs of Concept and sample implementations of a Blockchain in Python.

Table of Contents

Setup

Python

Required version: 3.7.*

Use pyenv or pyenv-installer to easily switch between multiple versions of Python.
Pipenv will automatically suggest and install the right version for this project.

Requirements

Use Pipenv to install the requirements needed

pipenv install

If pyenv is installed, Pipenv will automatically suggest and install the right version for this project.

Usage

All the needed commands are listed as GNU make target rules in the Makefile file.
Each subfolder could contain a local Makefile file, if needed.
Run the target rule with:

make <target_rule>

Example

Example: Run Jupyter Labs

make jupyter_lab

Development

Code

The source code is hosted on GitHub.

Setup

Use PipEnv to install also the requirements for development and testing

pipenv install --dev

Testing

Tests are executed using PyTest and pytest-cov plugin for coverage.

Contributing

Pull requests are welcome!

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Author

Nicola Costantino

License

MIT as listed in LICENSE file
Copyright (c) 2019 Nicola Costantino

Acknowledgments

Inspiration