Skip to content

Latest commit

 

History

History
165 lines (132 loc) · 7.99 KB

CHANGELOG.md

File metadata and controls

165 lines (132 loc) · 7.99 KB
Raw

Change Log

Unreleased

Added

  • Added Python 3.12 support #356
  • Template unit tests for documentation generation, linting and version bumping
  • Docstring for function
  • Intersphinx to documentation
  • Coverage and doctest commands for documentation #97
  • Added new 'docs' section in extra dependencies #317

Changed

  • Moved to src/ based layout for generated packages
  • Moved from setup.cfg/.py to pyproject.toml #351
  • Moved from prospector to ruff #336
  • Renamed project_name to directory_name in cookiecutter questionnaire
  • Initial linting is error free #227
  • Consolidated test/lint/build/docs into single matrix workflow #270
  • Enforce isort configuration
  • Default for package_short_description in cookiecutter questionnaire
  • Link checker ignores GH private pages and test pypi site #288
  • In CI build workflow make prospector die if there are errors #275
  • All example tests make use of example function
  • Use bumpversion for version in Sphinx config #44
  • Regenerated docs/conf.py with sphinx-quickstart v3.5.4 + enabled built-in extensions #44
  • Generate api rst files with extension instead of custom function #95
  • Change from bump2version (unmaintained) to bump-my-version.

Removed

  • Removed Python 3.7 support #343
  • .pylintrc file, was too strict, too soon #267
  • Unused development dependencies #167
  • Statements in project_setup.md already mentioned in README.dev.md
  • .zenodo.json is no longer necessary, CITATION.cff also works with Zenodo.

0.4.0

Added

  • Instructions to add your existing code to directory generated by the NLeSC Python template #202
  • Keywords to questionnaire #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

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
  • Drop Python 3.5 support
  • Removed unit tests doing the linting

0.2.0

Released on July 17, 2019

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

Released on July 12, 2018.

Added

  • 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