Skip to content

Commit ab656e0

Browse files
Readme and version updates, removed poetry.toml (#3)
1 parent 5baa0fa commit ab656e0

5 files changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cookiecutter Python Package
22

3-
My take on a [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package with Poetry as the dependency manager.
3+
A [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template for a Python package with Poetry as the dependency manager.
44

55
**NOTE:** Only Python 3.8+ is supported.
66

@@ -17,16 +17,24 @@ My take on a [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templa
1717

1818
- Install the `cookiecutter` library.
1919

20+
```python
21+
pip install cookiecutter
22+
```
23+
OR
2024
```python
2125
python -m pip install cookiecutter
2226
```
2327

2428
- Run the command:
29+
```python
30+
cookiecutter https://github.com/gurashish1singh/cookiecutter-python.git
31+
```
32+
OR
2533
```python
2634
python -m cookiecutter https://github.com/gurashish1singh/cookiecutter-python.git
2735
```
2836
- This template uses post-project generation hooks to:
2937
- Initialize a git repository (with default branch as main), IF the working directory is not already a git repository
3038
- Create a Poetry virtualenv
3139
- Install all dependencies
32-
- Install the pre-commit and pre-push hooks.
40+
- Install the pre-commit and pre-push hooks

cookiecutter.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
"github_repo_name": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
77
"project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
88
"project_short_description": "Minimal python cookiecutter template with Poetry as the dependency manager and Black, Isort, Flake8, Flake8-bugbear as the linters.",
9-
"version": "0.1.0",
9+
"version": "1.0.0",
1010
"pytest": ["y", "n"]
1111
}

poetry.toml

Lines changed: 0 additions & 2 deletions
This file was deleted.

{{ cookiecutter.project_slug }}/.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ repos:
2828
- id: flake8
2929
name: Running flake8 from local poetry env
3030
entry: poetry run flake8 .
31-
language: python
31+
language: system
3232
files: ".*.py"
3333
- id: isort
3434
name: Running isort from local poetry env
3535
entry: poetry run isort .
36-
language: python
36+
language: system
3737
files: ".*.py"
3838
- id: lizard
3939
name: Running lizard from local poetry env
40-
entry: poetry run lizard
40+
entry: poetry run lizard .
4141
# Max 7 arguments allowed, show only warnings, sort by CCN, exclude .venv
4242
args: ["--CCN", "8", "-a", "7", "-w", "-s", "cyclomatic_complexity", "-x", ".\\.venv\\*"]
4343
language: python

{{ cookiecutter.project_slug }}/poetry.toml

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)