Releases: lincc-frameworks/python-project-template
v1.4.1
What's Changed
- Updating the revision of pre-commit hook by @drewoldag in #239
Full Changelog: v1.4.0...v1.4.1
v1.4.0
Breaking changes!!!
Copier version 8.0 introduces several breaking changes. We've made the decision to push forward, and update our template and instructions to ONLY work with copier versions >= 8.0.
Please update copier before attempting to create new projects from this template, or update existing projects.
What's Changed
- Update pull_request_template.md by @drewoldag in #207
- pin copier below 8.0 by @cchris28 in #211
- how to convert to namespace project by @cchris28 in #210
- renamed namepace to namespace by @cchris28 in #213
- Updating PPT to handle Copier 8 by @drewoldag in #214
- support for older git versions at the cost of making the script less readable by @cchris28 in #220
- Add pylintrc configuration section to docs by @smcguire-cmu in #223
- Configure pytest to look in tests by default by @drewoldag in #222
- Completed "TODO" section of Best Practices: Linting by @drewoldag in #224
- Add Schmidt Futures blurb and line breaks. by @delucchi-cmu in #218
- Make all of sphinx documentation optional by @delucchi-cmu in #221
- Fixing a little bug in the template CI. by @drewoldag in #229
- Allow committing to main branch by @drewoldag in #225
- Switched black and pylint options in
copier.ymlby @drewoldag in #232 - List dependencies. Add help text. by @delucchi-cmu in #234
- Slim template for pull request description by @delucchi-cmu in #235
- Match RTD build steps by @delucchi-cmu in #236
Full Changelog: v1.3.5...v1.4.0
v1.3.5
What's Changed
- Add configuration to pyproject.toml so that isort works with black by @drewoldag in #195
- renamed package references by @cchris28 in #198
- fix: the project table was introduced in setuptools 62 by @henryiii in #196
- changed versions to >= for sphinx and sphinx-rtd-theme by @cchris28 in #200
- changed "pip install .[dev]" to include -e option in docs by @cchris28 in #203
New Contributors
Full Changelog: v1.3.4...v1.3.5
v1.3.4
What's Changed
- Added two more CI matrix cases to test rendered templates by @drewoldag in #174
- add missing eol at eof so github does not complain by @cchris28 in #172
- fixup two end of file eol by @cchris28 in #177
- Clarifying new project command line instructions by @drewoldag in #175
- Import functions explicitly, avoiding wildcard by @lsetiawan in #178
- Updating pre-commit command for sphinx builds. by @drewoldag in #179
- @uwcdc new PR template approval by @uwcdc in #181
- add type hints to example test for mypy strict by @cchris28 in #183
- added mypy tests for basic and strict by @cchris28 in #184
- added py.typed when mypy_type_checking is not none by @cchris28 in #187
- changed to pyproject.toml to install py.typed when using mypy by @cchris28 in #188
- Update question terminology, make validation text more concise by @drewoldag in #189
New Contributors
- @lsetiawan made their first contribution in #178
- @uwcdc made their first contribution in #181
Full Changelog: v1.3.3...v1.3.4
Several quality of life updates
What's Changed
- Lynn/tiny wording update by @olivialynn in #141
- Added jinja logic to exclude author_email if it is not provided. by @drewoldag in #149
- Update dates and authors in the default license files by @drewoldag in #148
- Update copier.yml by @olivialynn in #153
- Update template workflows so that they all run with python 3.8-3.10. by @drewoldag in #150
- Moved document building into it's own workflow by @drewoldag in #152
- Update documentation about using the template with existing projects. by @drewoldag in #155
- Updates to getting started documentation by @drewoldag in #156
- Overhauled the "update project" documentation. by @drewoldag in #157
- Adopting concise CLI switches for nbconvert pre-commit hook. by @drewoldag in #159
- Added more exclude patterns when not building notebooks. by @drewoldag in #161
- Add comment about keeping dependencies in sync manually by @drewoldag in #162
- Adding documentation about pre-commit. by @drewoldag in #163
- Updated names for 4 of the pre-commit hooks. by @drewoldag in #165
- Adding line breaks in .rst files. by @drewoldag in #166
Full Changelog: v1.3.2...v1.3.3
Cleaner docs and a template update reminder
What's Changed
- Ignore version and main files for autoapi. by @delucchi-cmu in #137
- Add pre-commit to check template version by @drewoldag in #138
Full Changelog: v1.3.1...v1.3.2
Bug fixing and better CI
What's Changed
- Update pyproject.toml.jinja by @delucchi-cmu in #129
- Lynn/small fixes by @olivialynn in #130
- Moved the Copier mypy question to the "custom" install decision path. by @drewoldag in #133
- Updating CI to cover nondefault options by @olivialynn in #132
Full Changelog: v1.3.0...v1.3.1
Easier documentation, pre-commit updates, and more
Lots of new features and updates were incorporated in this release. Automatic documentation is now easier with support for building notebooks automatically. Mypy checking is now offered as part of continuous integration. If you don't need example code and tests you can exclude those from hydrated templates. Lots of usability improvements and bug fixes.
New Contributors
A huge thank you to all the new contributors!
- @jeremykubica made their first contribution in #76
- @dougbrn made their first contribution in #82
- @olivialynn made their first contribution in #99
- @smcguire-cmu made their first contribution in #89
What's Changed
- Remove jinja from smoke test file name. by @delucchi-cmu in #67
- Sphinx documentation skeleton by @delucchi-cmu in #70
- Add a pyproject to get readthedocs support. by @delucchi-cmu in #72
- More "practices" stubs. Fix doc bits of template. by @delucchi-cmu in #74
- Update README.md by @drewoldag in #75
- Add a makefile to the docs directory by @jeremykubica in #76
- Add pipx callout by @dougbrn in #82
- Give two options for project license by @delucchi-cmu in #81
- Renamed directory from
nbtonotebooksby @drewoldag in #83 - Updated setup-python version, added python version matrix. by @drewoldag in #80
- Remove extraneous stuff from README. by @delucchi-cmu in #84
- Document the setup questions by @jeremykubica in #85
- Use pretty LINCC logo for RTD by @delucchi-cmu in #86
- Add the license question to the documentation by @jeremykubica in #87
- Slight tweaks to the README and RTD docs. by @drewoldag in #92
- Consolidate on .yml file extension as much as possible by @drewoldag in #91
- Adding pre-commit hook to prevent committing large files by @drewoldag in #93
- Reorganize the docs folder by @jeremykubica in #101
- Add ability to have a simple install by @jeremykubica in #102
- Change single quotes to double quotes. by @jeremykubica in #103
- Fix broken link. by @delucchi-cmu in #104
- Adding notebook support by @olivialynn in #99
- added git-lfs instructions with question to help start using git-lfs … by @cchris28 in #100
- Always create bare module directories. by @delucchi-cmu in #105
- Updating docs and copier question by @drewoldag in #113
- Add repo badge by @dougbrn in #108
- Add MyPy static Type Checking by @smcguire-cmu in #89
- Remove extra vertical space by @drewoldag in #117
- Update smoke-test.yml by @drewoldag in #115
- Add .pylintrc configuration files for src and test directories by @smcguire-cmu in #118
- Fixing pre-commit failures for new projects. by @drewoldag in #120
- Added to the list of excluded dirs/files. by @drewoldag in #121
- Final changes for notebook support by @olivialynn in #125
- Adding documentation for pulling the template into existing projects. by @drewoldag in #124
Full Changelog: v1.2.1...v1.3.0
v1.2.1
What's Changed
- Specify correct version of add-to-project action. by @drewoldag in #61
- Add cron smoke test by @delucchi-cmu in #63
- Allow hyphens in project name by @delucchi-cmu in #65
New Contributors
- @delucchi-cmu made their first contribution in #63
Full Changelog: 1.2.0...v1.2.1
1.2.0
What's Changed
- modified action to invoke pytest through python by @cchris28 in #48
- Make template tests run the same way hydrated template CI tests run by @drewoldag in #50
- Incorporating setuptools_scm to support programmatic version information by @drewoldag in #56
- Separated linting from the rest of the CI workflow. by @drewoldag in #57
- Add options for linting: pylint, black, none. Make isort optional. by @drewoldag in #58
- Put new issues in lincc-frameworks project by @drewoldag in #59
New Contributors
Full Changelog: v1.1.0...1.2.0