Commit 56a1985

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 56a1985Copy full SHA for 56a1985

File tree

3 files changed

+14

-16

lines changed

.github/workflows
- python-package.yml
.pre-commit-config.yaml
docs
- contributing.md

3 files changed

+14

-16

lines changed

`‎.github/workflows/python-package.yml‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ jobs:`
`15`	`15`	`strategy:`
`16`	`16`	`fail-fast: false`
`17`	`17`	`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"]`
`19`	`19`
`20`	`20`	`steps:`
`21`	`21`	`- uses: actions/checkout@v3`

`‎.pre-commit-config.yaml‎`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -21,13 +21,13 @@ repos:`
`21`	`21`	`hooks:`
`22`	`22`	`- id: mypy`
`23`	`23`	`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/`
`25`	`25`	`types: [python]`
`26`	`26`	`language: system`
`27`	`27`	`pass_filenames: false`
`28`	`28`	`- id: pytest`
`29`	`29`	`name: Pytest`
`30`		`- entry: poetry run pytest`
	`30`	`+ entry: uv run pytest`
`31`	`31`	`types: [python]`
`32`	`32`	`language: system`
`33`	`33`	`pass_filenames: false`

`‎docs/contributing.md‎`

Lines changed: 11 additions & 13 deletions

Original file line number	Diff line number	Diff line change
@@ -87,7 +87,7 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
`87`	`87`
`88`	`88`	`1. Install dependencies.`
`89`	`89`	`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/)`
`91`	`91`
`92`	`92`	1. Fork the `python-statemachine` repository on GitHub.
`93`	`93`
@@ -96,31 +96,29 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
`96`	`96`	`git clone https://github.com/YOUR-USERNAME/python-statemachine.git.`
`97`	`97`
`98`	`98`
`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::
`100`	`100`
`101`		`- poetry install --all-extras`
	`101`	`+ uv sync --all-extras`
`102`	`102`
`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:`
`106`	`104`
`107`	`105`	`pre-commit install`
`108`	`106`
`109`		`-1. Create a branch for local development:`
	`107`	`+3. Create a branch for local development:`
`110`	`108`
`111`	`109`	`git checkout -b <name-of-your-bugfix-or-feature>`
`112`	`110`
`113`		`-1. Make changes to the code.`
	`111`	`+4. Make changes to the code.`
`114`	`112`
`115`		`-1. Run tests to ensure they pass by running:`
	`113`	`+5. Run tests to ensure they pass by running:`
`116`	`114`
`117`		`- poetry run pytest`
	`115`	`+ uv run pytest`
`118`	`116`
`119`		`-1. Update the documentation as needed.`
	`117`	`+6. Update the documentation as needed.`
`120`	`118`
`121`	`119`	`Build the documentation:`
`122`	`120`
`123`		`- poetry run sphinx-build docs docs/_build/html`
	`121`	`+ uv run sphinx-build docs docs/_build/html`
`124`	`122`
`125`	`123`
`126`	`124`	`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
`133`	`131`	If you're specially writting documentation, I strongly recommend using `sphinx-autobuild`
`134`	`132`	`as it improves the workflow watching for file changes and with live reloading:`
`135`	`133`
`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/.*"`
`137`	`135`
`138`	`136`	`Sometimes you need a full fresh of the files being build for docs, you can safely remove`
`139`	`137`	`all automatically generated files to get a clean state by running:`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 56a1985

File tree

3 files changed

3 files changed

`‎.github/workflows/python-package.yml‎`

`‎.pre-commit-config.yaml‎`

`‎docs/contributing.md‎`

0 commit comments