Releases: at-gmbh/at-python-template
v1.1.1
🔥 AT Python Template v1.1.1 - Dependency Updates
📅 Release Date: 2025-03-13
🔗 Changelog: View full changelog
🚀 Performance Improvements
- Improved efficiency in pre-commit hooks by upgrading
astral-sh/ruff-pre-commit
to v0.9.10.
✨ Enhancements
- Updated
setuptools
to v76 to ensure better dependency resolution. - Updated
pytest
to v8.3.5 for improved testing capabilities. - Updated
typer
to v0.15.2, enhancing command-line tool support. - Improved overall dependency alignment to maintain consistency.
🐞 Bug Fixes
- Fixed inconsistencies with
ruff
execution in pre-commit hooks. - Addressed minor compatibility issues caused by outdated dependencies.
🔄 How to Update
To update your local setup with the latest changes from this release, follow these steps:
Navigate to the at-python-template project directory and update your local at-python-template copy:
git pull origin master
pre-commit autoupdate
🛠 Need Help?
If you encounter any issues, feel free to open an issue or start a discussion. 🚀
v1.1.0
We’re excited to announce the release of v1.1.0 of the AT Python Template! This release brings a number of improvements aimed at streamlining dependency management, refining our development workflow, and enhancing overall project consistency.
Key Highlights
Dependency Improvements & Maintenance
- Core Dependency Caretaking: Thanks to proactive efforts by @ChrsBaur, our core dependencies have been carefully maintained and updated.
Pre-commit Hook Updates by Renovatebot
pre-commit/pre-commit-hooks
Update: Upgraded to the latest version for improved hook performance.pycqa/isort
Update: Upgraded to enhance code formatting consistency.
Enhanced Development Workflow
- Python Version Requirement: Adjusted to require Python 3.9 or later.
- Streamlined Dependency Management: GitHub Actions now rely solely on
poetry
for dependency management. - Code Refactoring: Replaced
pkg_resources
withimportlib.resources
for improved utility code. - Testing Enhancements: Added support for
pytest-cov
v6 and integrated test coverage reporting into the GitHub Actions pipeline. - CI/CD & Tooling Updates:
- Updated Conda Docker tag to
v24
in theDockerfile
. - Upgraded various GitHub Actions (e.g.,
actions/checkout
to v4). - Improved GitLab CI caching configuration for Conda packages.
- Updated Conda Docker tag to
For a complete list of changes, please see the full changelog.
v1.0.1
This patch release fixes an issue with Conda package caching in GitLab CI. The caching configuration in {{ cookiecutter.project_slug }}/.gitlab-ci.yml
has been updated to include the new .conda
file format as well as additional cache directories.
Changes include:
- Updated caching paths to:
$PIP_CACHE_DIR
$CONDA_PKGS_DIRS/*.conda
$CONDA_PKGS_DIRS/*.tar.bz2
$CONDA_PKGS_DIRS/urls*
$CONDA_PKGS_DIRS/cache
For a full list of changes, please refer to the CHANGELOG.md.
v1.0.0
🚀 AT Python Template v1.0.0 - Initial Stable Release
🗓 Release Date: 2025-02-26
📖 Full Changelog: [View commits](https://github.com/at-gmbh/at-python-template/commits/v1.0.0)
We’re excited to announce the first stable release of the AT Python Template! 🎉 This release marks a major milestone by providing a production-ready and modular Python project setup. Designed for both exploratory work and deployment, this template helps developers kickstart new projects efficiently.
✨ What's New in v1.0.0
🚀 New Features
- Modular Project Structure: Uses a
src/
directory for better code organization. - Flexible Package Management: Supports
pip
,poetry
, andconda
. - Automated Project Setup: Uses
cookiecutter
for quick and easy project initialization. - Pre-configured CLI Support: Built-in support for
typer
, enabling command-line applications. - Pre-commit Hooks & Linting: Integrated
ruff
for code formatting and linting. - Docker Integration: Pre-configured
Dockerfile
anddocker-compose.yml
for containerization. - Automated Testing: Uses
pytest
for unit testing. - Jupyter Notebook Compatibility: Comes with a dedicated
notebooks/
folder. - Configuration Management: Supports YAML and HOCON via the
config/
directory. - Editor Support: Pre-configured settings for VS Code and PyCharm.
- CI/CD Integrations: Includes GitHub Actions and GitLab CI for continuous integration.
- Automated Dependency Updates: Uses
renovate
to keep dependencies up to date. - Improved User Prompts: More human-readable prompts enhance project setup.
- Versioning Enforcement: Requires Python 3.8+, dropping support for Python 3.7.
🔄 Improvements & Enhancements
- Refactored Codebase: Ensures maintainability and modularity.
- Updated Default Dependencies: Improves performance and security.
- Enhanced User Prompts: More intuitive options during project creation.
- Replaced
.format()
Calls: Now using f-strings for better readability. - Simplified Installation Steps: Improved documentation and
README.md
structure. - CI/CD Pipeline Improvements: Enhanced GitHub Actions workflows.
🛠 Fixes
- Setup Issues: Fixed module placement under
src/
. - Documentation Fixes: Corrected broken paths, URLs, and typos.
- Pre-commit Hook Adjustments: Ensured all hooks function correctly.
- Whitespace Cleanups: Addressed formatting inconsistencies in generated files.
🏆 Contributors & Pull Requests
This release includes contributions from many developers. Thank you to everyone who contributed! ❤️
🔥 Major Contributions
- CI Pipeline for pytest by [@klamann](https://github.com/klamann) - [#1](#1)
- Poetry Support by [@Arrrlex](https://github.com/Arrrlex) - [#17](#17)
- Docker Improvements by [@carsten-bo](https://github.com/carsten-bo) - [#92](#92)
- Updated README by [@SimonCW](https://github.com/SimonCW) - [#4](#4)
- Pre-commit hooks update by [@klamann](https://github.com/klamann) - [#6](#6)
- Improved User Prompts by [@ChrsBaur](https://github.com/ChrsBaur) - [#115](#115)
- Switched to Poetry by [@ChrsBaur](https://github.com/ChrsBaur) - [#117](#117)
- Replaced
.format()
with f-strings by [@Alex23rodriguez](https://github.com/Alex23rodriguez) - [#125](#125) - Added CONTRIBUTION.md by [@ChrsBaur](https://github.com/ChrsBaur) - [#148](#148)
- Added CHANGELOG.md and set version to 1.0.0 by [@ChrsBaur](https://github.com/ChrsBaur) - [#150](#150)
➡️ Full list of merged PRs: [GitHub Pull Requests](https://github.com/at-gmbh/at-python-template/pulls?q=is%3Apr+is%3Amerged)
🎉 New Contributors
A huge thank you to our first-time contributors:
- [@Arrrlex](https://github.com/Arrrlex) - [#17](#17)
- [@sbunzel](https://github.com/sbunzel) - [#19](#19)
- [@shagn](https://github.com/shagn) - [#23](#23)
- [@MaxPensel](https://github.com/MaxPensel) - [#42](#42)
- [@MichaelGehring](https://github.com/MichaelGehring) - [#47](#47)
- [@ChrsBaur](https://github.com/ChrsBaur) - [#66](#66)
- [@takuyen](https://github.com/takuyen) - [#63](#63)
- [@ncbkr](https://github.com/ncbkr) - [#82](#82)
- [@erwinru](https://github.com/erwinru) - [#93](#93)
- [@Alex23rodriguez](https://github.com/Alex23rodriguez) - [#125](#125)
📥 How to Upgrade
To upgrade to the latest version of the AT Python Template, simply clone the repository and follow the updated instructions in the README.md.
git clone https://github.com/at-gmbh/at-python-template.git
cd at-python-template
If you've already used the template in a project, refer to the Changelog for key updates and consider migrating manually.
Have suggestions or want to contribute? Feel free to open a discussion or a PR! 💡
🐞 Report an issue: [GitHub Issues](https://github.com/at-gmbh/at-python-template/issues)
🚀 Thank you for using AT Python Template! 🚀