Skip to content

Commit 0afba0a

Browse files
committed
Minor updates to the project files
1 parent 672f21e commit 0afba0a

File tree

4 files changed

+28
-15
lines changed

4 files changed

+28
-15
lines changed

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ repos:
1414
- id: mixed-line-ending
1515
- id: trailing-whitespace
1616
- repo: https://github.com/astral-sh/ruff-pre-commit
17-
rev: v0.8.6
17+
rev: v0.9.4
1818
hooks:
1919
- id: ruff
2020
args: [--fix]

CONTRIBUTING.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,27 @@ typo fixes where an issue may not be needed).
1818
2. Clone the repository:
1919

2020
```sh
21-
git clone [email protected]:<YOUR_USERNAME>/rich-argparse.git
22-
cd rich_argparse
21+
git clone [email protected]:<YOUR_USERNAME>/rich-argparse.git rich-argparse
22+
cd rich-argparse
2323
```
2424
3. Create and activate a virtual environment:
2525

26+
Linux and macOS:
2627
```sh
27-
python3 -m venv venv
28-
. venv/bin/activate # Linux and macOS
28+
python3 -m venv .venv
29+
. .venv/bin/activate
30+
```
31+
32+
Windows:
33+
```sh
34+
py -m venv .venv
35+
.venv\Scripts\activate
2936
```
30-
> **Note**
31-
> Windows users follow [this guide][venv-guide] to create and activate a virtual environment.
3237

3338
4. Install the project and its dependencies:
3439

3540
```sh
36-
python3 -m pip install -r requirements-dev.txt
41+
python -m pip install -r requirements-dev.txt
3742
```
3843

3944
## Testing
@@ -60,4 +65,3 @@ your pull request, and link it to any relevant issues or discussions.
6065
[mypy]: https://mypy.readthedocs.io/en/stable/
6166
[ruff]: https://docs.astral.sh/ruff/
6267
[PR]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
63-
[venv-guide]: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -283,14 +283,14 @@ Alternatively, you can use the `DjangoRichHelpFormatter` class directly in your
283283

284284
```diff
285285
diff --git a/my_app/management/commands/my_command.py b/my_app/management/commands/my_command.py
286-
from django.core.management.base import BaseCommand
286+
from django.core.management.base import BaseCommand
287287
+from rich_argparse.django import DjangoRichHelpFormatter
288288

289-
class Command(BaseCommand):
290-
def add_arguments(self, parser):
289+
class Command(BaseCommand):
290+
def add_arguments(self, parser):
291291
+ parser.formatter_class = DjangoRichHelpFormatter
292-
parser.add_argument("--option", action="store_true", help="An option")
293-
...
292+
parser.add_argument("--option", action="store_true", help="An option")
293+
...
294294
```
295295

296296
## Optparse support

pyproject.toml

+10-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,16 @@ Issue-Tracker = "https://github.com/hamdanal/rich-argparse/issues"
3939
Changelog = "https://github.com/hamdanal/rich-argparse/blob/main/CHANGELOG.md"
4040

4141
[tool.hatch.build.targets.sdist]
42-
include = ["CHANGELOG.md", "CONTRIBUTING.md", "requirements-dev.txt", "rich_argparse", "tests", "LICENSE", "README.md", "pyproject.toml" ]
42+
include = [
43+
"CHANGELOG.md",
44+
"CONTRIBUTING.md",
45+
"requirements-dev.txt",
46+
"rich_argparse",
47+
"tests",
48+
"LICENSE",
49+
"README.md",
50+
"pyproject.toml",
51+
]
4352

4453
[tool.hatch.build.targets.wheel]
4554
packages = ["rich_argparse"]

0 commit comments

Comments
 (0)