Skip to content

Releases: NLeSC/python-template

0.6.1

03 Sep 09:01
a142959
Compare
Choose a tag to compare

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

0.6.0

30 Aug 09:53
55b80ed
Compare
Choose a tag to compare

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

0.5.0

15 Aug 13:35
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: 0.4.0...0.5.0

0.4.0

03 May 14:51
809ea02
Compare
Choose a tag to compare

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

0.3.0

22 Apr 14:20
ce276a6
Compare
Choose a tag to compare

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

0.2.0

17 Jul 15:25
Compare
Choose a tag to compare

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

0.1.0

12 Jul 09:49
Compare
Choose a tag to compare

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