@@ -33,18 +33,17 @@ Follow these steps to get started with this template:
3333
34341 . ** Clone the repository or use the template directly via GitHub.**
3535
36- 2 . ** Install Poetry :**
36+ 2 . ** Install uv :**
3737
38- Ensure you have [ Poetry ] ( https://python-poetry.org / ) installed. If not, you can install it using:
38+ Ensure you have [ uv ] ( https://docs.astral.sh/uv / ) installed. If not, you can install it using:
3939 ``` bash
40- pip install poetry
40+ curl -LsSf https://astral.sh/uv/ install.sh | sh
4141 ```
42- > ** Note:** This template is set up using Poetry version 1.8.5.
4342
44433 . ** Install dependencies:**
4544
4645 ``` bash
47- poetry install
46+ uv sync
4847 ```
4948
50494 . ** Ready to Implement:**
@@ -57,7 +56,7 @@ Follow these steps to get started with this template:
5756This project includes a continuous integration (CI) workflow that is triggered on every push and pull request, using
5857GitHub Actions to run the following jobs:
5958
60- 1 . ** Setup** : Checks out the code, sets up Python, and installs dependencies using Poetry .
59+ 1 . ** Setup** : Checks out the code, sets up Python, and installs dependencies using uv .
61602 . ** Format** : Formats the code with Ruff.
62613 . ** Lint** : Runs linting on the codebase with Ruff.
63624 . ** Type Check** : Checks for type consistency using Mypy.
@@ -79,10 +78,10 @@ This project includes the following dependencies:
7978 - ` loguru ` : ^0.7.3 (useful logging package)
8079
8180- ** Development Dependencies** :
82- - ` ruff ` : ^0.8 .x (for code linting and formatting)
81+ - ` ruff ` : ^0.14 .x (for code linting and formatting)
8382 - ` mypy ` : ^1.x.y (for type checking)
8483 - ` pre-commit ` : ^4.x.y (for managing Git hooks)
85- - ` pytest ` : ^8 .x.y (for unit testing)
84+ - ` pytest ` : ^9 .x.y (for unit testing)
8685
8786### Optional: Pyenv
8887
@@ -147,20 +146,20 @@ This repository employs several tools to ensure code quality:
147146To set up pre-commit hooks for automatic formatting and linting on commit, ensure ` pre-commit ` is installed:
148147
149148``` bash
150- poetry install
149+ uv sync
151150```
152151
153152Then, install the hooks:
154153
155154``` bash
156- poetry run pre-commit install
155+ uv run pre-commit install
157156```
158157
159158Once installed, the hooks will run automatically before each commit.
160159
161160### Pre-commit Hooks Configuration
162161
163- This repository uses pre-commit hooks to enforce code quality and standards before committing changes. Here’ s an
162+ This repository uses pre-commit hooks to enforce code quality and standards before committing changes. Here' s an
164163overview of the configured hooks:
165164
166165#### 1. Commitlint Hook
@@ -179,13 +178,13 @@ overview of the configured hooks:
179178You can run specific hooks manually using:
180179
181180``` bash
182- poetry run pre-commit run < HOOK-ID>
181+ uv run pre-commit run < HOOK-ID>
183182```
184183
185184For example, to run the Ruff formatter:
186185
187186``` bash
188- poetry run pre-commit run ruff-format
187+ uv run pre-commit run ruff-format
189188```
190189
191190For more information on pre-commit, visit [ pre-commit.com] ( https://pre-commit.com ) .
0 commit comments