Skip to content
This repository was archived by the owner on Feb 7, 2024. It is now read-only.

Commit b2ab0a9

Browse files
committed
🚚 renamed License file
1 parent 9b1ea7c commit b2ab0a9

File tree

6 files changed

+14
-23
lines changed

6 files changed

+14
-23
lines changed
File renamed without changes.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Yet another [cookiecutter](https://github.com/cookiecutter/cookiecutter) templat
99

1010
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1111
[![Semantic Versions](https://img.shields.io/badge/%F0%9F%9A%80-semantic%20versions-informational.svg)](https://github.com/TezRomacH/python-package-template/releases)
12-
[![License](https://img.shields.io/github/license/TezRomacH/python-package-template)](https://github.com/TezRomacH/python-package-template/blob/master/LICENCE)
12+
[![License](https://img.shields.io/github/license/TezRomacH/python-package-template)](https://github.com/TezRomacH/python-package-template/blob/master/LICENSE)
1313

1414
Your next Python package needs bleeding edge project structure.
1515
</div>
@@ -42,7 +42,7 @@ For building and deployment:
4242
For creating your open source community:
4343

4444
- Ready-to-use [Pull Requests templates](https://github.com/TezRomacH/python-package-template/blob/master/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/TezRomacH/python-package-template/tree/master/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/ISSUE_TEMPLATE).
45-
- Files such as: `LICENCE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
45+
- Files such as: `LICENSE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
4646
- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/TezRomacH/python-package-template/blob/master/%7B%7B%20cookiecutter.project_name%20%7D%7D/.github/.stale.yml).
4747
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
4848

@@ -344,9 +344,9 @@ Here is a list of things that have yet to be implemented:
344344

345345
## 🛡 License
346346

347-
[![License](https://img.shields.io/github/license/TezRomacH/python-package-template)](https://github.com/TezRomacH/python-package-template/blob/master/LICENCE)
347+
[![License](https://img.shields.io/github/license/TezRomacH/python-package-template)](https://github.com/TezRomacH/python-package-template/blob/master/LICENSE)
348348

349-
This project is licensed under the terms of the `MIT` licence. See [LICENSE](https://github.com/TezRomacH/python-package-template/blob/master/LICENCE) for more details.
349+
This project is licensed under the terms of the `MIT` licence. See [LICENSE](https://github.com/TezRomacH/python-package-template/blob/master/LICENSE) for more details.
350350

351351
## 🏅 Credits
352352

hooks/post_gen_project.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,7 @@ def print_futher_instuctions() -> None:
4949
5050
$ make install
5151
52-
4) Run codestyle (codestyle uses `pre-commit`; ensure you've run `make install`):
53-
54-
$ make codestyle
55-
56-
5) Upload initial code to GitHub:
52+
4) Upload initial code to GitHub (ensure you've run `make install` to use `pre-commit`):
5753
5854
$ git add .
5955
$ git commit -m ":tada: Initial commit"

{{ cookiecutter.project_name }}/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ check-safety:
103103
$(POETRY_COMMAND_FLAG)poetry check
104104
$(PIP_COMMAND_FLAG)pip check
105105
$(SAFETY_COMMAND_FLAG)poetry run safety check --full-report
106-
$(BANDIT_COMMAND_FLAG)poetry run bandit -r **/*.py
106+
$(BANDIT_COMMAND_FLAG)poetry run bandit -ll -r {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/
107107

108108
.PHONY: check-style
109109
check-style:

{{ cookiecutter.project_name }}/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1010
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
1111
[![Semantic Versions](https://img.shields.io/badge/%F0%9F%9A%80-semantic%20versions-informational.svg)](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/releases)
12-
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }})](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENCE)
12+
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }})](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENSE)
1313

1414
{{ cookiecutter.project_description }}
1515
</div>
@@ -36,13 +36,7 @@ make download-poetry
3636
make install
3737
```
3838

39-
4. Run codestyle (codestyle uses `pre-commit`; ensure you've run `make install`):
40-
41-
```bash
42-
make codestyle
43-
```
44-
45-
5. Upload initial code to `GitHub`:
39+
4. Upload initial code to GitHub (ensure you've run `make install` to use `pre-commit`):
4640

4741
```bash
4842
git add .
@@ -119,7 +113,7 @@ For building and deployment:
119113
For creating your open source community:
120114

121115
- Ready-to-use [Pull Requests templates](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/tree/master/.github/ISSUE_TEMPLATE).
122-
- Files such as: `LICENCE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
116+
- Files such as: `LICENSE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
123117
- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/.github/.stale.yml).
124118
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
125119

@@ -341,9 +335,9 @@ You can update it in [`release-drafter.yml`](https://github.com/{{ cookiecutter.
341335

342336
## 🛡 License
343337

344-
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }})](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENCE)
338+
[![License](https://img.shields.io/github/license/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }})](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENSE)
345339

346-
This project is licensed under the terms of the `{{ cookiecutter.license }}` licence. See [LICENSE](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENCE) for more details.
340+
This project is licensed under the terms of the `{{ cookiecutter.license }}` licence. See [LICENSE](https://github.com/{{ cookiecutter.github_name }}/{{ cookiecutter.project_name }}/blob/master/LICENSE) for more details.
347341

348342
## 📃 Citation
349343

{{ cookiecutter.project_name }}/{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
# type: ignore[attr-defined]
12
"""{{ cookiecutter.project_description }}"""
23

34
try:
4-
from importlib.metadata import version, PackageNotFoundError # type: ignore
5+
from importlib.metadata import version, PackageNotFoundError
56
except ImportError: # pragma: no cover
6-
from importlib_metadata import version, PackageNotFoundError # type: ignore
7+
from importlib_metadata import version, PackageNotFoundError
78

89

910
try:

0 commit comments

Comments
 (0)