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

More modules and shorter intro

Browse Source
This commit is contained in:
Luke Murphy 2020-08-09 11:21:48 +02:00
parent f93424594c
commit d70e63aed4
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
index.md
View File

@ -6,24 +6,26 @@ An implementation of the prole2prole protocol in Python.
### Progress ### Progress
> [github.com/hyperpy](https://github.com/hyperpy) #### W.I.P
- [ ] [simple-hypercore-protocol](https://github.com/hyperpy/simple-hypercore-protocol) - [hyperspace-client](https://github.com/hyperpy/hyperspace-client)
- [x] [simple-message-channels](https://github.com/hyperpy/simple-message-channels) - [simple-hypercore-protocol](https://github.com/hyperpy/simple-hypercore-protocol)
- [x] [pyvarint](https://github.com/hyperpy/pyvarint)
- [x] [hypercore-crypto](https://github.com/hyperpy/hypercore-crypto) #### Published
- [x] [merkle-tree-stream](https://github.com/hyperpy/merkle-tree-stream)
- [x] [flat-tree](https://github.com/hyperpy/flat-tree) - [hyperspace-rpc](https://github.com/hyperpy/hyperspace-rpc)
- [hyper-rpc](https://github.com/hyperpy/hyper-rpc)
- [simple-message-channels](https://github.com/hyperpy/simple-message-channels)
- [pyvarint](https://github.com/hyperpy/pyvarint)
- [hypercore-crypto](https://github.com/hyperpy/hypercore-crypto)
- [merkle-tree-stream](https://github.com/hyperpy/merkle-tree-stream)
- [flat-tree](https://github.com/hyperpy/flat-tree)
### Join In ### Join In
Feel most welcome to join! Hyperpy is a non-commercial volunteer-run project Feel most welcome to join! Hyperpy is a non-commercial volunteer-run project.
which currently receives no funding. We hope the funding situation will change Please do [come and say hello](#get-in-touch)! We are tracking our progress on
but right now, we're doing it because we think it is important and try to make [this project board](https://github.com/users/decentral1se/projects/1).
time for it alongside the rest of \$life. With that said, please do [come and
say hello](#get-in-touch)!
We are tracking our progress on [this project board](https://github.com/users/decentral1se/projects/1).
The two main needs we have right now are are 1. applying for grant funding 2. The two main needs we have right now are are 1. applying for grant funding 2.
python programming. python programming.
@ -39,17 +41,20 @@ module looks like this.
and seems interesting to you. You can generally find the corresponding and seems interesting to you. You can generally find the corresponding
source code under [github.com/mafintosh/](https://github.com/mafintosh/) or source code under [github.com/mafintosh/](https://github.com/mafintosh/) or
[github.com/hypercore-protocol](https://github.com/hypercore-protocol/). [github.com/hypercore-protocol](https://github.com/hypercore-protocol/).
1. Firstly, try to understand the high-level of what module is trying to 1. Firstly, try to understand the high-level of what module is trying to
achieve. Then, try to browse and grok the Javascript. If you need help from achieve. Then, try to browse and grok the Javascript. If you need help from
the implementors of that module, you can most likely find them hanging out the implementors of that module, you can most likely find them hanging out
in [the Hypercore protocol Discord in [the Hypercore protocol Discord
server](https://discord.com/invite/ga5hxGf) or on IRC at the `#dat` channel server](https://discord.com/invite/ga5hxGf) or on IRC at the `#dat` channel
on the Freenode network. on the Freenode network.
1. Before starting, you'll need to investigate if the ways of doing things in 1. Before starting, you'll need to investigate if the ways of doing things in
the Javascript module can be translated to Python. For example, how NodeJS the Javascript module can be translated to Python. For example, how NodeJS
streams work will not easily translate to the way we use streams in Python. 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 / It is good to have an idea of what will need to be changed / created /
adapted to before diving into the implementation. adapted to before diving into the implementation.
1. Finally, go ahead and implement the module! If you like, you can use [this 1. Finally, go ahead and implement the module! If you like, you can use [this
Python package Python package
cookiecutter](https://git.autonomic.zone/decentral1se/pypkgtemplate) to get cookiecutter](https://git.autonomic.zone/decentral1se/pypkgtemplate) to get