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

Commit

Permalink
🚚 renamed License file
Browse files Browse the repository at this point in the history
  • Loading branch information
TezRomacH committed May 7, 2020
1 parent 9b1ea7c commit b2ab0a9
Showing 6 changed files with 14 additions and 23 deletions.
File renamed without changes.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ Yet another [cookiecutter](https://github.com/cookiecutter/cookiecutter) templat

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

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

- 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).
- Files such as: `LICENCE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
- Files such as: `LICENSE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
- [`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).
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).

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

## 🛡 License

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

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.
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.

## 🏅 Credits

6 changes: 1 addition & 5 deletions hooks/post_gen_project.py
Original file line number Diff line number Diff line change
@@ -49,11 +49,7 @@ def print_futher_instuctions() -> None:
$ make install
4) Run codestyle (codestyle uses `pre-commit`; ensure you've run `make install`):
$ make codestyle
5) Upload initial code to GitHub:
4) Upload initial code to GitHub (ensure you've run `make install` to use `pre-commit`):
$ git add .
$ git commit -m ":tada: Initial commit"
2 changes: 1 addition & 1 deletion {{ cookiecutter.project_name }}/Makefile
Original file line number Diff line number Diff line change
@@ -103,7 +103,7 @@ check-safety:
$(POETRY_COMMAND_FLAG)poetry check
$(PIP_COMMAND_FLAG)pip check
$(SAFETY_COMMAND_FLAG)poetry run safety check --full-report
$(BANDIT_COMMAND_FLAG)poetry run bandit -r **/*.py
$(BANDIT_COMMAND_FLAG)poetry run bandit -ll -r {{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}/

.PHONY: check-style
check-style:
16 changes: 5 additions & 11 deletions {{ cookiecutter.project_name }}/README.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
[![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)
[![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)
[![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)

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

4. Run codestyle (codestyle uses `pre-commit`; ensure you've run `make install`):

```bash
make codestyle
```

5. Upload initial code to `GitHub`:
4. Upload initial code to GitHub (ensure you've run `make install` to use `pre-commit`):

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

- 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).
- Files such as: `LICENCE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
- Files such as: `LICENSE.md`, `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are generated automatically.
- [`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).
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).

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

## 🛡 License

[![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)
[![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)

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.
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.

## 📃 Citation

Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# type: ignore[attr-defined]
"""{{ cookiecutter.project_description }}"""

try:
from importlib.metadata import version, PackageNotFoundError # type: ignore
from importlib.metadata import version, PackageNotFoundError
except ImportError: # pragma: no cover
from importlib_metadata import version, PackageNotFoundError # type: ignore
from importlib_metadata import version, PackageNotFoundError


try:

0 comments on commit b2ab0a9

Please sign in to comment.