Skip to content

v1.0.0

Choose a tag to compare

View all tags
@ChrsBaur ChrsBaur released this 26 Feb 12:12
· 85 commits to master since this release
v1.0.0
6c0540c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🚀 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, and conda.
  • 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 and docker-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

➡️ 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:

📥 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! 🚀

Assets 2
Loading