@@ -18,21 +18,19 @@ Setting up for local development
1818 $ git clone https://github.com/marshmallow-code/marshmallow-sqlalchemy.git
1919 $ cd marshmallow-sqlalchemy
2020
21- 2. Install development requirements. ** It is highly recommended that you use a virtualenv. **
22- Use the following command to install an editable version of
23- marshmallow-sqlalchemy along with its development requirements.
21+ 2. Install ` uv < https://docs.astral.sh/uv/getting-started/installation/ >`_.
22+
23+ 3. Install development requirements.
2424
2525.. code-block :: shell-session
2626
27- # After activating your virtualenv
28- $ pip install -e '.[dev]'
27+ $ uv sync
2928
30- 3. Install the pre-commit hooks, which will format and lint your git staged files.
29+ 4. (Optional but recommended) Install the pre-commit hooks, which will format and lint your git staged files.
3130
3231.. code-block :: shell-session
3332
34- # The pre-commit CLI was installed above
35- $ pre-commit install
33+ $ uv run pre-commit install --allow-missing-config
3634
3735 Pull requests
3836--------------
@@ -70,19 +68,19 @@ To run all tests:
7068
7169.. code-block :: shell-session
7270
73- $ pytest
71+ $ uv run pytest
7472
7573 To run formatting and syntax checks:
7674
7775.. code-block :: shell-session
7876
79- $ tox -e lint
77+ $ uv run tox -e lint
8078
8179 (Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed):
8280
8381.. code-block :: shell-session
8482
85- $ tox
83+ $ uv run tox
8684
8785 Documentation
8886-------------
@@ -93,7 +91,7 @@ To build and serve the docs in "watch" mode:
9391
9492.. code-block :: shell-session
9593
96- $ tox -e docs-serve
94+ $ uv run tox -e docs-serve
9795
9896 Changes to documentation will automatically trigger a rebuild.
9997
0 commit comments