Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethereum/dopple
Dopple: JSON-RPC Proxy Server
https://github.com/ethereum/dopple
ethereum json-rpc json-rpc-server json-rpc-transport proxy-server python
Last synced: 1 day ago
JSON representation
Dopple: JSON-RPC Proxy Server
- Host: GitHub
- URL: https://github.com/ethereum/dopple
- Owner: ethereum
- License: apache-2.0
- Created: 2017-12-22T14:27:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-18T18:17:40.000Z (almost 5 years ago)
- Last Synced: 2024-09-13T19:12:08.102Z (12 days ago)
- Topics: ethereum, json-rpc, json-rpc-server, json-rpc-transport, proxy-server, python
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 6
- Watchers: 25
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dopple
HTTP proxy to Unix Socket based JSON-RPC servers
## Installation
```sh
pip install dopple
```
## Use
```sh
dopple ~/.ethereum/geth.ipc http://127.0.0.1:8545
```
Alternatively, `dopple` can be invoked as a pure script without installation:
```sh
./dopple/dopple.py ~/.ethereum/geth.ipc http://127.0.0.1:8545
```
These values above are the default ones too. If they match your current configuration, they can be ommitted.
Check out `--help` option for more information.
Read more in the [documentation on ReadTheDocs](https://dopple.readthedocs.io/). [View the change log](https://dopple.readthedocs.io/en/latest/releases.html).
## License
Apache-2.0
## Developer Setup
If you would like to hack on dopple, please check out the [Snake Charmers
Tactical Manual](https://github.com/ethereum/snake-charmers-tactical-manual)
for information on how we do:
- Testing
- Pull Requests
- Code Style
- Documentation
### Development Environment Setup
You can set up your dev environment with:
```sh
git clone [email protected]:ethereum/dopple.git
cd dopple
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[dev]
```
### Testing Setup
During development, you might like to have tests run on every file save.
Show flake8 errors on file change:
```sh
# Test flake8
when-changed -v -s -r -1 dopple/ tests/ -c "clear; flake8 dopple tests && echo 'flake8 success' || echo 'error'"
```
Run multi-process tests in one command, but without color:
```sh
# in the project root:
pytest --numprocesses=4 --looponfail --maxfail=1
# the same thing, succinctly:
pytest -n 4 -f --maxfail=1
```
Run in one thread, with color and desktop notifications:
```sh
cd venv
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on dopple failed'" ../tests ../dopple
```
### Release setup
For Debian-like systems:
```
apt install pandoc
```
To release a new version:
```sh
make release bump=$$VERSION_PART_TO_BUMP$$
```
#### How to bumpversion
The version format for this repo is `{major}.{minor}.{patch}` for stable, and
`{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta).
To issue the next version in line, specify which part to bump,
like `make release bump=minor` or `make release bump=devnum`. This is typically done from the
master branch, except when releasing a beta (in which case the beta is released from master,
and the previous stable branch is released from said branch).
If you are in a beta version, `make release bump=stage` will switch to a stable.
To issue an unstable version when the current version is stable, specify the
new version explicitly, like `make release bump="--new-version 4.0.0-alpha.1 devnum"`