Skip to content

575-user-profiles #623

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
lyashevska merged 6 commits into from
Aug 29, 2024
Merged

575-user-profiles #623

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
caeef1b
first version for readme
lyashevska Aug 28, 2024
f555923
Update text
lyashevska Aug 28, 2024
361cefd
Update changelog
lyashevska Aug 28, 2024
8af8a86
Update README.md
lyashevska Aug 28, 2024
e0f0131
Update README.md
lyashevska Aug 29, 2024
076aaac
Merge branch 'main' into 575-user-profiles
lyashevska Aug 29, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)

### Changed
* Update the user documentation (README.md) of the template [#575](https://github.com/NLeSC/python-template/pull/623)
* added value field to license options [#617](https://github.com/NLeSC/python-template/pull/617)
* fix filename typo of githooks [#611](https://github.com/NLeSC/python-template/pull/609)
* next_steps.md is shown as a copier message [#609](https://github.com/NLeSC/python-template/pull/609)
Expand Down
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Netherlands eScience Center Python Template

Spend less time setting up and configuring your new Python packages which includes research software good practices from the start.
Are you writing research software? Save your time on setting up and configuring your new Python packages by using this template. This [Copier-based](https://copier.readthedocs.io) template includes best practices for research software from the beginning. You can choose from various user profiles, each offering a range of features to suit your needs.

Use this [Copier](https://copier.readthedocs.io) template to generate an empty Python package. Features include:
## User profiles
- **Minimum**
As the name suggests, this profile provides the bare essentials to get started with a Python package.This is a good place to start if this is your first time writing research software. You can always add more features later.
- **Recommended**
Building on the Minimum profile, this option includes a carefully selected set of features that we believe users will find useful. However, all features can be customized by the user.
- **Let me choose**
This fully customizable profile allows you to select from a list of features to include in your package according to your preferences.

## Features

- Boilerplate unit tests and documentation,
- [Python static setup configuration](template/pyproject.toml.jinja),
Expand All @@ -14,7 +22,7 @@ Use this [Copier](https://copier.readthedocs.io) template to generate an empty P
- [README.md](template/README.md.jinja) for package users,
- [README.dev.md](template/README.dev.md.jinja) for package developer,
- [project_setup.md](template/project_setup.md.jinja) with extensive documentation about project setup,
- [Change log](template/%7B%25%20if%20AddChangeLog%20%25%7DCHANGELOG.md%7B%25%20endif%20%25%7D),
- [Changelog](template/%7B%25%20if%20AddChangeLog%20%25%7DCHANGELOG.md%7B%25%20endif%20%25%7D),
- [Code of Conduct](template/CODE_OF_CONDUCT.md.jinja),
- [Contributing guidelines](template/CONTRIBUTING.md.jinja),
- Continuous code quality and code coverage reporting using [Sonarcloud](https://sonarcloud.io/),
Expand Down