|
|
@ -8,20 +8,31 @@ 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 |
|
|
|
``` |
|
|
|
|
|
|
|
To publish: |
|
|
|
```bash |
|
|
|
twine upload dist/* |
|
|
|
``` |
|
|
|
|
|
|
|
## Test |
|
|
|
|
|
|
|
To run the tests, install the package with the `[dev]` option: |
|
|
|
To run the tests, call: |
|
|
|
|
|
|
|
```bash |
|
|
|
pip install -e .[dev] |
|
|
|
pytest |
|
|
|
``` |
|
|
|
|
|
|
|