From 7f98b79af5346dbb22b0e13be3603c5ce4d4d4e3 Mon Sep 17 00:00:00 2001 From: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com> Date: Mon, 25 Dec 2023 13:32:19 +1100 Subject: [PATCH] Bump to 1.3.0 --- README.rst | 25 ++++++++++++++++--------- pyproject.toml | 3 +++ src/pook/__init__.py | 2 +- 3 files changed, 20 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index dc05ebc..76355a1 100644 --- a/README.rst +++ b/README.rst @@ -249,39 +249,46 @@ Clone the repository: git clone git@github.com:h2non/pook.git -Install dependencies: +Use [`hatch`](https://hatch.pypa.io/) to configure the environment by running the test suite: .. code:: bash - pip install -r requirements.txt -r requirements-dev.txt + hatch run test -Install Python dependencies: +Install the pre-commit hook: .. code:: bash - make install + hatch run lint:install -Lint code: +Lint the code: .. code:: bash - make lint + hatch run lint:run -Run tests: +Run tests on all supported Python versions and implementations (this requires your host operating system to have each implementation available): .. code:: bash - make test + hatch run test:test + + +To run tests only for a specific version, affix the version designation to the environment name (the left side of the `:`): + +.. code:: bash + + hatch run test.pypy3.10:test Generate documentation: .. code:: bash - make htmldocs + hatch run docs:build License diff --git a/pyproject.toml b/pyproject.toml index 94f1408..4f5c00b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -82,8 +82,11 @@ extra-dependencies = [ "Sphinx~=7.2.6 ", "sphinx-rtd-theme~=2.0.0", ] + +[tool.hatch.envs.docs.scripts] apidocs = 'sphinx-apidoc -f --follow-links -H "API documentation" -o docs/source src/pook' htmldocs = 'rm -rf docs/_build && sphinx-build -b html -d docs/_build/doctrees ./docs docs/_build/html' +build = 'hatch run apidocs; hatch run htmldocs' [tool.hatch.envs.test] [[tool.hatch.envs.test.matrix]] diff --git a/src/pook/__init__.py b/src/pook/__init__.py index 3f8c617..64c7422 100644 --- a/src/pook/__init__.py +++ b/src/pook/__init__.py @@ -9,4 +9,4 @@ __license__ = "MIT" # Current version -__version__ = "1.2.1" +__version__ = "1.3.0"