hyperpy
/
hyperpy.decentral1.se
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix URL and clarify steps

This commit is contained in:
Luke Murphy 2020-07-07 17:02:25 +02:00
parent 295dc83068
commit 617a2e680e
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
index.md
View File

@ -1,6 +1,6 @@
## Hypercore Protocol in Python
> https://hypercore-protocol.org
> [hypercore.protocol.org](https://hypercore-protocol.org)
A prole-to-prole implementation for the ones who write Python.
@ -14,10 +14,16 @@ A prole-to-prole implementation for the ones who write Python.
### How to Help
1. Look at [this](https://datcxx.github.io/hypercore.svg) image of the Hypercore dependency graph and pick a module that is not already implemented. You can see the latest Python work at [github.com/hyperpy](https://github.com/hyperpy).
1. Implement the module! You can use [this package cookiecutter](https://git.autonomic.zone/decentral1se/pypkgtemplate) to get started fast and use the same configuration as the other modules. If you need help from the Nodejs side, you can join [their Discord channels](https://discord.com/invite/ga5hxGf), they are a friendly bunch.
Feel most welcome to join! It is a good idea to [come and say hello](#get-in-touch). We're friendly :rainbow:.
If you're not sure how to start, [come chat with us](#get-in-touch).
In general, the steps go something like this.
1. Look at [this graph](https://datcxx.github.io/hypercore.svg) of the Hypercore dependency graph and pick a module that is not already implemented and seems interesting to you.
1. Try to understand the high-level of what module is trying to achieve. Then, read the Javascript. If you need help from the implementors of that module, you can most likely find them hanging out in [the Hypercore protocol Discord server](https://discord.com/invite/ga5hxGf), they are also a friendly bunch.
1. Since Javascript is different from Python, you'll need to investigate if the ways of doing things in the Javascript module can be used on the Python side. For example, how NodeJS streams work will not easily translate to the way we use streams in Python. It is good to have an idea of what will need to be changed / created / adapted to before diving into the implementation.
1. Finally, go ahead and implement the module! You can use [this package cookiecutter](https://git.autonomic.zone/decentral1se/pypkgtemplate) to get started fast and use the same configuration as the other modules.
You can see the latest Python work at [github.com/hyperpy](https://github.com/hyperpy).
### Get in Touch