Skip to content

Commit

Permalink
Blockchain validation succeded, first release
Browse files Browse the repository at this point in the history
  • Loading branch information
giacomocaironi committed Sep 15, 2023
1 parent 9f4cd3b commit d0ac764
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# btclib_node

A bitcoin node written in python
[btclib_node](https://github.com/btclib-org/btclib_node) is a bitcoin node with its consensus and network code written in python, using the [btclib](https://github.com/btclib-org/btclib) bitcoin library.

**btclib_node** succeded in downloading and validating the entire bitcoin blokchain, starting from version 0.1.0 and, as far as I can tell, is the first python implementatin that was able to do so

## Test, develop, and contribute

The project uses [hatch](https://hatch.pypa.io/latest/) as a project manager.

Some additional tools are required to develop and test btclib_node, they can be installed using poetry:

poetry install

To test:

pytest

To measure the code coverage provided by tests:

pytest --cov-report term-missing:skip-covered --cov=btclib_node

To format the code

isort . && black .
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "btclib-node"
version = "0.0.0"
version = "0.1.0"
description = "Bitcoin node in python"
authors = ["Giacomo Caironi <[email protected]>"]
license = "MIT"
Expand Down

0 comments on commit d0ac764

Please sign in to comment.