varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-12 16:10:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove outdated sections of README (#76)

Browse Source 
* remove gitter, testing setup, and pandoc sections, add quotes to dev install
This commit is contained in:
Paul Robinson
2023-04-10 11:11:35 -06:00
committed by pacrob
parent ffd6ad8b9f
commit 91d93efdd0
1 changed files with 1 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,6 +1,5 @@
# <PROJECT_NAME> # <PROJECT_NAME>
[![Join the chat at https://gitter.im/ethereum/<REPO_NAME>](https://badges.gitter.im/ethereum/<REPO_NAME>.svg)](https://gitter.im/ethereum/<REPO_NAME>?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://circleci.com/gh/ethereum/<REPO_NAME>.svg?style=shield)](https://circleci.com/gh/ethereum/<REPO_NAME>) [![Build Status](https://circleci.com/gh/ethereum/<REPO_NAME>.svg?style=shield)](https://circleci.com/gh/ethereum/<REPO_NAME>)
[![PyPI version](https://badge.fury.io/py/<PYPI_NAME>.svg)](https://badge.fury.io/py/<PYPI_NAME>) [![PyPI version](https://badge.fury.io/py/<PYPI_NAME>.svg)](https://badge.fury.io/py/<PYPI_NAME>)
[![Python versions](https://img.shields.io/pypi/pyversions/<PYPI_NAME>.svg)](https://pypi.python.org/pypi/<PYPI_NAME>) [![Python versions](https://img.shields.io/pypi/pyversions/<PYPI_NAME>.svg)](https://pypi.python.org/pypi/<PYPI_NAME>)
@ -37,43 +36,11 @@ git clone git@github.com:ethereum/<REPO_NAME>.git
cd <REPO_NAME> cd <REPO_NAME>
virtualenv -p python3 venv virtualenv -p python3 venv
. venv/bin/activate . venv/bin/activate
pip install -e .[dev] 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 <MODULE_NAME>/ tests/ -c "clear; flake8 <MODULE_NAME> 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 <REPO_NAME> failed'" ../tests ../<MODULE_NAME>
``` ```
### Release setup ### Release setup
For Debian-like systems:
```
apt install pandoc
```
To release a new version: To release a new version:
```sh ```sh