Skip to content

Commit bb1ad90

Browse files
author
root
committed
trigger GHA
1 parent c992f39 commit bb1ad90

File tree

4 files changed

+54
-109
lines changed

4 files changed

+54
-109
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ dist-contents: build
5757

5858
# Check code quality
5959
check:
60-
ruff check .
60+
ruff check . --fix
6161
find . -wholename "./newtype/extensions/*.c" -exec cppcheck {} +
6262

6363
# Format code

docs/development/building.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,46 @@ git clone https://github.com/yourusername/python-newtype.git
1919
cd python-newtype
2020
```
2121

22-
2. Install dependencies using Poetry:
23-
```bash
24-
poetry install --no-root
25-
```
26-
27-
3. Activate the virtual environment:
28-
```bash
29-
poetry shell
30-
```
31-
32-
Alternatively, you can use `venv` to create and activate a virtual environment.
33-
Create a new virtual environment using `venv`:
22+
2. Create a new virtual environment using `venv`:
3423

3524
For Linux:
25+
3626
```bash
3727
python3 -m venv venv
38-
source venv/bin/activate
28+
source .venv/bin/activate
3929
```
4030
For Windows:
31+
4132
```bash
4233
python -m venv venv
43-
.\venv\Scripts\activate
34+
.\.venv\Scripts\activate
4435
```
4536

46-
Then, get poetry to use it:
37+
3. Install `poetry`:
38+
39+
```bash
40+
pip install poetry
41+
```
42+
43+
4. Get poetry to use the virtual environment in the project directory:
44+
4745
```bash
4846
poetry config virtualenvs.in-project true
4947
```
48+
5049
This will ensure that Poetry uses the current virtual environment located in the project directory.
5150
You can also set the virtual environment path explicitly if needed.
5251
For example:
53-
`poetry config virtualenvs.path /path/to/your/venvs`
52+
53+
```bash
54+
poetry config virtualenvs.path /path/to/your/venvs
55+
```
56+
57+
Then, you can install all development dependencies using
58+
59+
```bash
60+
poetry install --with dev --no-root --no-interaction
61+
```
5462

5563
## Project Structure
5664

poetry.lock

Lines changed: 15 additions & 78 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,26 @@ generate-setup-file = false
3737
generate-ref-docs = "scripts.generate_ref_docs:main"
3838

3939
[tool.poetry.dependencies]
40-
python = ">=3.8"
40+
python = ">=3.8,<4.0"
4141
typing-extensions = "*"
4242

4343
[tool.poetry.group.dev.dependencies]
4444
pre_commit = "*"
45-
ruff = "^0.1.14"
46-
mypy = "^1.8.0"
45+
ruff = "*"
46+
mypy = "*"
4747
isort = "*"
4848
creosote = "*"
49-
pre-commit = "^3.6.0"
50-
tomli = "^2.1.0"
51-
poetry-dynamic-versioning = "^1.4.1"
52-
pytest = "^8.0.0"
53-
pytest-cov = "^5.0.0"
54-
pytest-asyncio = "^0.24.0"
55-
pytest-mock = "^3.12.0"
56-
mkdocs = "^1.5.3"
57-
mkdocs-material = "^9.5.3"
58-
mkdocstrings = {extras = ["python"], version = "^0.24.0"}
59-
black = "^24.1.1"
49+
pre-commit = "^3"
50+
tomli = "^2"
51+
poetry-dynamic-versioning = "*"
52+
pytest = "*"
53+
pytest-cov = "*"
54+
pytest-asyncio = "*"
55+
pytest-mock = "*"
56+
mkdocs = "*"
57+
mkdocs-material = "*"
58+
mkdocstrings = {extras = ["python"], version = "*"}
59+
black = "*"
6060
numpy = ">=1.24.0,<1.25.0" # Pin numpy version
6161
pandas = ">=2.0.0,<2.1.0" # Pin pandas version to be compatible with numpy
6262

0 commit comments

Comments
 (0)