Skip to content

Commit 56a1985

Browse files
authored
chore: Fix pre-commit and update docs references for Poetry to UV (#492)
* chore: Fix pre-commit and update docs references for Poetry to UV * chore: Using release version of Python3.13 in build matrix
1 parent a5ef7fe commit 56a1985

3 files changed

Lines changed: 14 additions & 16 deletions

File tree

.github/workflows/python-package.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
strategy:
1616
fail-fast: false
1717
matrix:
18-
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0-rc.1"]
18+
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0"]
1919

2020
steps:
2121
- uses: actions/checkout@v3

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ repos:
2121
hooks:
2222
- id: mypy
2323
name: Mypy
24-
entry: poetry run mypy --namespace-packages --explicit-package-bases statemachine/ tests/
24+
entry: uv run mypy --namespace-packages --explicit-package-bases statemachine/ tests/
2525
types: [python]
2626
language: system
2727
pass_filenames: false
2828
- id: pytest
2929
name: Pytest
30-
entry: poetry run pytest
30+
entry: uv run pytest
3131
types: [python]
3232
language: system
3333
pass_filenames: false

docs/contributing.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
8787

8888
1. Install dependencies.
8989
1. [graphviz](https://graphviz.org/download/#linux)
90-
1. [poetry](https://python-poetry.org/docs/#installation)
90+
1. [uv](https://docs.astral.sh/uv/getting-started/installation/)
9191

9292
1. Fork the `python-statemachine` repository on GitHub.
9393

@@ -96,31 +96,29 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
9696
git clone https://github.com/YOUR-USERNAME/python-statemachine.git.
9797

9898

99-
1. Run `poetry install` once to install all the dependencies and create a virtual environment::
99+
1. Run `uv sync` once to install all the development dependencies and create a virtual environment::
100100

101-
poetry install --all-extras
101+
uv sync --all-extras
102102

103-
1. Run `poetry shell` to enter the provided virtual
104-
105-
1. Install the pre-commit validations:
103+
2. Install the pre-commit validations:
106104

107105
pre-commit install
108106

109-
1. Create a branch for local development:
107+
3. Create a branch for local development:
110108

111109
git checkout -b <name-of-your-bugfix-or-feature>
112110

113-
1. Make changes to the code.
111+
4. Make changes to the code.
114112

115-
1. Run tests to ensure they pass by running:
113+
5. Run tests to ensure they pass by running:
116114

117-
poetry run pytest
115+
uv run pytest
118116

119-
1. Update the documentation as needed.
117+
6. Update the documentation as needed.
120118

121119
Build the documentation:
122120

123-
poetry run sphinx-build docs docs/_build/html
121+
uv run sphinx-build docs docs/_build/html
124122

125123

126124
Now you can serve the local documentation using a webserver, like the built-in included
@@ -133,7 +131,7 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
133131
If you're specially writting documentation, I strongly recommend using `sphinx-autobuild`
134132
as it improves the workflow watching for file changes and with live reloading:
135133

136-
poetry run sphinx-autobuild docs docs/_build/html --re-ignore "auto_examples/.*"
134+
uv run sphinx-autobuild docs docs/_build/html --re-ignore "auto_examples/.*"
137135

138136
Sometimes you need a full fresh of the files being build for docs, you can safely remove
139137
all automatically generated files to get a clean state by running:

0 commit comments

Comments
 (0)