mm/announce-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated instructions for build, new pkgs

Browse Source
This commit is contained in:
Michael Pilosov 2023-03-19 17:10:52 -06:00
parent f6b715cd65
commit 1d502d2107
2 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -8,20 +8,26 @@ A Python library that announces a server to a host.
pip install announce-server pip install announce-server
``` ```
## Development
To install the developer dependencies required for testing and publishing:
```bash
pip install -e .[dev,pub]
```
## Build ## Build
To build the package, run: To build the package, run:
```bash ```bash
pip install -e .[dev] rm -rf dist/ build/ .eggs/ .pytest_cache/ src/announce_server.egg-info/
pip install -m build python -m build --sdist --wheel
``` ```
## Test ## Test
To run the tests, install the package with the `[dev]` option: To run the tests, call:
```bash ```bash
pip install -e .[dev]
pytest pytest
``` ```

9
setup.cfg
View File

@ -31,13 +31,16 @@ where = src
[options.extras_require] [options.extras_require]
dev = dev =
build
setuptools_scm
pytest pytest
pytest-mock pytest-mock
pytest-asyncio pytest-asyncio
pytest-cov pytest-cov
# asynctest; python_version<'3.8'
pub =
build
wheel
setuptools_scm
twine
[coverage:run] [coverage:run]
source = announce_server source = announce_server