diff --git a/README.md b/README.md index 952e432..d2dd6ab 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/setup.cfg b/setup.cfg index 82a17c0..0e6bd7b 100644 --- a/setup.cfg +++ b/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