Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump to 1.3.0 #101

Merged
merged 1 commit into from
Dec 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down
2 changes: 1 addition & 1 deletion src/pook/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
__license__ = "MIT"

# Current version
__version__ = "1.2.1"
__version__ = "1.3.0"