updated instructions for build, new pkgs
This commit is contained in:
parent
f6b715cd65
commit
1d502d2107
14
README.md
14
README.md
@ -8,20 +8,26 @@ A Python library that announces a server to a host.
|
||||
pip install announce-server
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
To install the developer dependencies required for testing and publishing:
|
||||
```bash
|
||||
pip install -e .[dev,pub]
|
||||
```
|
||||
|
||||
## Build
|
||||
To build the package, run:
|
||||
|
||||
```bash
|
||||
pip install -e .[dev]
|
||||
pip install -m build
|
||||
rm -rf dist/ build/ .eggs/ .pytest_cache/ src/announce_server.egg-info/
|
||||
python -m build --sdist --wheel
|
||||
```
|
||||
|
||||
## Test
|
||||
|
||||
To run the tests, install the package with the `[dev]` option:
|
||||
To run the tests, call:
|
||||
|
||||
```bash
|
||||
pip install -e .[dev]
|
||||
pytest
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user