What's Changed

Added

• Add .gitignore and .editorconfig to the list of files that are not updated if they exist #655

Changed

• copyright owner is asked in all profiles #629
• license files includes year and copyright owner information #629
• combine all the next step jobs in a single workflow #657
• fix CITATION.cff validation issues which also helps cffconvert workflow to pass #657

Removed

• Remove pyproject.toml and CITATION.cff from the list of files that are not updated if they exist #655

Full Changelog: 0.6.0...0.6.1

What's Changed

Added

• Keep project_setup.md for all the profiles and remove from the menu #576
• Make contributing guidelines optional #465
• Make linting optional #568
• Make editorconfig optional #571
• Make contributing guidelines optional #465
• Make developer documentation optional #467
• Make Code of Conduct optional #464
• New YAML files for copier questions #529
• Make zenodo next step instructions optional #520
• Make SonarCloud optional #515
• Make citation optional #471
• Make online documentation optional #476
• Make local documentation optional #593
• Make local test optional #594

Changed

• Update the user documentation (README.md) of the template #575
• Updated .gitignore #622
• add extra info for sub-menus #628
• skip merging CHANGELOG.md and CODE_OF_CONDUCT.md if they exist #628
• added value field to license options #617
• fix filename typo of githooks #611
• next_steps.md is shown as a copier message #609
• Change the default profile to 'recommended' #598
• Updated the user documentation (README.md) of the template #569
• Droped Python 3.8 and 3.9 support #551
• Fix broken link checker #546
• pre-commit script is optional (#457)
• CHANGELOG.md is now optional (#462)

Removed

• Remove the configuration of isort (#591), which is no longer used since #347.

Full Changelog: 0.5.0...0.6.0

What's Changed

• rename project_name as directory_name by @fdiblen in #278
• replaced reference to John Smith to Jane Smith by @jspaaks in #279
• updated links in badges with package name by @jspaaks in #283
• project package naming by @jspaaks in #284
• renamed template dir name by @jspaaks in #285
• fix sonarcloud link by @fdiblen in #286
• Random bits by @sverhoeven in #287
• Make linting a separate job on CI by @egpbos in #304
• remove double CI build triggers by @egpbos in #303
• Fix markdown-link-check errors by @abelsiqueira in #307
• Update cffconvert.yml to version 2.0.0 by @abelsiqueira in #309
• Add tox and change coverage configuration by @egpbos in #311
• Create Pull Request template by @abelsiqueira in #308
• add diff to isort so that the output actually tells you what to do... by @egpbos in #315
• add myst_parser to allow markdown files in toclist in docs by @egpbos in #316
• add .tox to .gitignore by @egpbos in #320
• remove --tmpdir from mktemp in README.dev.md by @egpbos in #319
• update checkout and setup-python github actions to v3 by @egpbos in #321
• add separate documentation GA workflow by @egpbos in #314
• Fixes authentication confusion by @apalha in #325
• Update python versions in CI matrix: -3.6, +3.10, +3.11 by @sjvrijn in #329
• run CI only on push/PR to main by @sjvrijn in #330
• include LPGLv3+ in template by @sjvrijn in #331
• Small fix to PR template by @abelsiqueira in #338
• Remove --recursive from isort in pre-commit by @abelsiqueira in #339
• Update cff-version to 1.2.0 by @abelsiqueira in #334
• Python info steps: switch bash -l to bash -e by @egpbos in #341
• [WIP] Fix Windows tests by @egpbos in #342
• add read/write permissions to allow issue creation by @bvreede in #340
• Remove more python3/pip3 commands from docs by @egpbos in #344
• Update project_setup.md by @cwmeijer in #346
• use ruff instead of prospector and isort (Refs #336) by @cwmeijer in #347
• Re-use baked project for all tests by @bouweandela in #353
• move setup.cfg to pyproject.toml by @sjvrijn in #352
• fix broken link by @egpbos in #357
• Update supported python versions: -3.7, +3.12 by @sjvrijn in #359
• use python -m build to build by @egpbos in #358
• Remove remaining setup.cfg references by @sjvrijn in #363
• switch from bump2version to bump-my-version by @egpbos in #365
• add link to impact discussion by @egpbos in #366
• Mention the guide in contribution guidelines and pull request template by @bouweandela in #371
• Assorted changes: audience, contributing guidelines, remove .zenodo.json by @egpbos in #368
• Bumpversion bug by @f-hafner in #377
• include an action point of adding changes to changelog in PR template by @sjvrijn in #386
• Fix broken link to contribution guidelines in pull request template by @bouweandela in #390
• Move generated package to src/ layout by @sjvrijn in #374
• Add extra optional-dependencies section for documentation requirements by @sjvrijn in #387
• Update ruff configuration by @sjvrijn in #384
• Remove unused isort configuration by @bouweandela in #392
• 378b ruff config update dbodor by @DaniBodor in #397
• Enable quiet mode for markdown link checker by @sjvrijn in #385

New Contributors

• @abelsiqueira made their first contribution in #307
• @apalha made their first contribution in #325
• @sjvrijn made their first contribution in #329
• @bvreede made their first contribution in #340
• @bouweandela made their first contribution in #353
• @f-hafner made their first contribution in #377
• @DaniBodor made their first contribution in #397

Full Changelog: 0.4.0...0.5.0

Spend less time setting up and configuring your new Python packages and comply with the
Netherlands eScience Center Software Development Guide
from the start.

Added

• Instructions to add your existing code to directory generated by the NLeSC Python template #202
• Keywords to questionaire #270
• Next step issue generation workflow #228
• Next step issue for SonarCloud integration #234
• Next step issue for Zenodo integration #235
• Next step issue for Read the Docs #236
• Next step issue for citation data #237
• Next step issue for linting #238
• Next steps documentation #240
• Support for sub packages in distro #160
• Tests for api doc generation #213
• CI Tests on Windows #140 #223
• .pylintrc file
• Valid license name and first author name in CITATION.cff
• SonarCloud integration for code quality and coverage #89
• Read the Docs #78

Changed

• Always generate API docs #176
• Have 100% test coverage in generated code #88

Removed

• Automatic publish to PyPi after GitHub release #196

Added

• Added Python 3.9 support
• Template is being tested for Python 3.6, 3.7, 3.8, 3.9
• Added extra badges such as fair-software.eu badges and SonarCloud, GitHub Actions #52 #57
• Added issue templates #159
• Added cffconvert GitHub action #91
• Added Markdown Link Checker GitHub action
• Added Developer documentation
• Added cookiecutter post-hook to point to document with more information
• Migrated to static setup.cfg as per the recommended practice #84
• Added Pre-commit githook to automatically run the linters before committing to GitHub #82
• Added Sonarcloud integration for static analysis and code coverage #172
• Added badges to the generated package

Changed

• Moved requirements.txt dependencies to setup.cfg and removed requirements.txt #67
• Replaced all ReStructuredText (rst) files by Markdown #190 #162
• Use matrix build for generated project to support all current Python versions on Windows, Linux, Mac #160
• Updated CITATION.cff, .zenodo.json; removed codemeta.json #127 #137
• Updated Code of Conduct of the template
• Simplified templating variables using cookiecutter pre-hook #82
• Consolidated pytest.ini into setup.cfg #155
• Versioning now handled with bump2version #192
• Updated project_setup.md #165
• Updated Code of Conduct for generated package
• Improved the documentation for the generated package and template itself

Removed

• Dropped appveyor #160
• Dropped everything Conda related
• Dropped Python 3.5 support
• Removed unit tests doing the linting

Added

• Set up logging and provide a logging example (#9)
• Fix for displaying wide tables in the documentation (#37)
• Single source version number (+ documentation) (#29)
• Cookiecutter tests (#15)
• Linter test for the generated project
• CITATION.cff
• Support for pypi deployment using travis (#36)

Changed

• Replace dashes and spaces in project_slug with underscore (#33)
• Put project setup documentation in a separate document (#39)
• Fix numbered lists in .rst files (#40)
• Added rst, y(a)ml and cwl to .editorconfig (#35)
• Default documentation theme is sphinx_rtd_theme (#34)
• Improve licensing
• Fix example tests that failed to run (#28)
• Remove quotes from project name and project description (#27)
• Update prospector configuration (#26)
  • Make prospector less strict
  • Have prospector ignore the docs directory
• Add install_requires to setup.py (#21)
• Improved .gitignore (#22)
• More detailed documentation about
  • Project setup
  • Setup instructions
  • NOTICE file

Removed

• Python 2 support

First version of the Python project template that follows the Netherlands eScience Center software development guide, containing:

• Tests,
• Documentation,
• Code style checking
• Editorconfig
• Default Travis configuration
• Change log
• Code of Conduct
• Contributing guidelines
• License
• Manifest.in
• README
• Requirements.txt
• Setup configuration