Browse Source

updated instructions for build, new pkgs

hosting
Michael Pilosov 2 years ago
parent
commit
1d502d2107
  1. 14
      README.md
  2. 9
      setup.cfg

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
```

9
setup.cfg

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

Loading…
Cancel
Save