Skip to content

project package naming #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jspaaks merged 2 commits into from
May 3, 2021
Merged

project package naming #284

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77de9b0
updated a few lingering project_name s
jspaaks May 3, 2021
750e3e8
Merge remote-tracking branch 'origin/main' into 274-project-package-n…
jspaaks May 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@ Use this [Cookiecutter](https://cookiecutter.readthedocs.io) template to generat
an empty Python package. Features include:

- Boilerplate unit tests and documentation,
- [Python static setup configuration]({{cookiecutter.project_name}}/setup.cfg),
- [Python static setup configuration]({{cookiecutter.directory_name}}/setup.cfg),
- Open source software license,
- Continuous integration with [GitHub action workflows]({{cookiecutter.project_name}}/.github/workflows) for building, testing, link checking and linting,
- Continuous integration with [GitHub action workflows]({{cookiecutter.directory_name}}/.github/workflows) for building, testing, link checking and linting,
- Code style checking with [prospector](https://pypi.org/project/prospector/),
- [Editorconfig]({{cookiecutter.project_name}}/.editorconfig),
- [Editorconfig]({{cookiecutter.directory_name}}/.editorconfig),
- Usage and contribution documents:
- [README.md]({{cookiecutter.project_name}}/README.md) for package users,
- [README.dev.md]({{cookiecutter.project_name}}/README.dev.md) for package developer,
- [project_setup.md]({{cookiecutter.project_name}}/project_setup.md) with extensive documentation about project setup,
- [Change log]({{cookiecutter.project_name}}/CHANGELOG.md),
- [Code of Conduct]({{cookiecutter.project_name}}/CODE_OF_CONDUCT.md),
- [Contributing guidelines]({{cookiecutter.project_name}}/CONTRIBUTING.md),
- [README.md]({{cookiecutter.directory_name}}/README.md) for package users,
- [README.dev.md]({{cookiecutter.directory_name}}/README.dev.md) for package developer,
- [project_setup.md]({{cookiecutter.directory_name}}/project_setup.md) with extensive documentation about project setup,
- [Change log]({{cookiecutter.directory_name}}/CHANGELOG.md),
- [Code of Conduct]({{cookiecutter.directory_name}}/CODE_OF_CONDUCT.md),
- [Contributing guidelines]({{cookiecutter.directory_name}}/CONTRIBUTING.md),
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/),
- Automatic creation of [issues]({{cookiecutter.project_name}}/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs,
- Instructions how to make package [citable]({{cookiecutter.project_name}}/.github/next_steps/04_citation.md)
- Automatic creation of [issues]({{cookiecutter.directory_name}}/.github/next_steps) with instructions how to pass all GitHub action workflows and integrate with services like Zenodo and Read the Docs,
- Instructions how to make package [citable]({{cookiecutter.directory_name}}/.github/next_steps/04_citation.md)
- FAIR software recommendation badge,
- Optional [pre commit hook](https://github.com/NLeSC/python-template/blob/main/%7B%7Bcookiecutter.project_name%7D%7D/README.dev.md#running-linters-locally) to catch lint errors early
- Optional [pre commit hook]({{cookiecutter.directory_name}}/README.dev.md#running-linters-locally) to catch lint errors early

## Badges

Expand Down Expand Up @@ -144,7 +144,7 @@ my-python-project/
└── test_my_module.py
```

For an explanation of what's there, read on in the [project_setup.md]({{cookiecutter.project_name}}/project_setup.md) file.
For an explanation of what's there, read on in the [project_setup.md]({{cookiecutter.directory_name}}/project_setup.md) file.
There are also instructions on how to [apply the template to an existing Python package](ADD_TO_EXISTING_PACKAGE.md).

## Examples
Expand Down