Merge remote-tracking branch 'origin/master' into SimonCW-patch-1

Author: ChrsBaur

.github/workflows/tests-conda.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.11]
+        python-version: [3.9, 3.11]
         os: [ubuntu-latest, windows-latest]
     name: "Test: Python ${{ matrix.python-version }}, conda, ${{ matrix.os }}"
     steps:

.github/workflows/tests-pip.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.11]
+        python-version: [3.9, 3.11]
         os: [ubuntu-latest, windows-latest]
     name: "Test: Python ${{ matrix.python-version }}, pip, ${{ matrix.os }}"
     steps:
@@ -25,29 +25,28 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        pip install .
     - name: Test with pytest
       run: |
         pytest tests
 
   version-check:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6]
-        os: [ubuntu-20.04]
+        python-version: [ 3.9,  3.11 ]
     name: "Version Check: Python ${{ matrix.python-version }}"
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Cookiecutter
-      run: |
-        python -m pip install --upgrade pip
-        pip install cookiecutter~=1.7.2
-    - name: Run Version Check
-      run: |
-        python tests/version_check.py --fail
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Cookiecutter and dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install cookiecutter packaging
+      - name: Run Version Check
+        run: |
+          python tests/version_check.py --fail

.github/workflows/traffic.yml

@@ -26,7 +26,7 @@ jobs:
 
     # Commits files to repository
     - name: Commit changes
-      uses: EndBug/[email protected].1
+      uses: EndBug/[email protected].4
       with:
         token: ${{ secrets.TRAFFIC_ACTION_TOKEN }}
         author_name: GH-Action-Traffic

.gitignore

@@ -55,19 +55,22 @@ target/
 # Jupyter Notebook
 .ipynb_checkpoints
 
+# pyenv
+.python-version
+
 # virtualenv
 .env
 .venv
 venv*/
 
+# OS specific
+.DS_Store
+
 # IDE settings
 .vscode/
 .idea/
 *.iws
 
-# Pyenv
-.python-version
-
 # project-specific stuff
 serve/
-cookiecutter-server.yml
+cookiecutter-server.yml

.pre-commit-config.yaml

@@ -3,7 +3,6 @@ repos:
     rev: v4.4.0
     hooks:
     -   id: check-added-large-files
-    -   id: check-ast
     -   id: check-merge-conflict
     -   id: end-of-file-fixer
     -   id: mixed-line-ending

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Placeholder for future updates and new features.
+
+## [1.0.0] - 2025-02-26
+
+### Added
+- **Initial stable release** of the AT Python Template.
+- **Modular project structure** using `src/` directory for better code organization.
+- **Flexible package management** with options for `pip`, `poetry`, and `conda`.
+- **Automated project setup** using `cookiecutter` to streamline project generation.
+- **Pre-configured CLI support** via `typer`, enabling command-line applications.
+- **Pre-commit hooks** with `ruff` for formatting and linting.
+- **Docker integration** with `Dockerfile` and `docker-compose.yml` for containerized deployment.
+- **Automated testing setup** using `pytest` for unit testing.
+- **Jupyter Notebook compatibility** with a dedicated `notebooks/` folder.
+- **Configuration management** using `config/` directory and YAML/HOCON formats.
+- **Editor support** with settings for **VS Code** and **PyCharm**.
+- **Multiple CI/CD integrations** including **GitHub Actions** and **GitLab CI**.
+- **Automated dependency updates** using `renovate`.
+- **Updated documentation** covering installation, project structure, and setup steps.
+- **Human-readable prompts** improving user experience during project generation.
+- **Versioning enforcement** requiring **Python 3.8+** while dropping Python 3.7 support.
+
+### Changed
+- **Refactored codebase** to ensure maintainability and modularity.
+- **Updated default dependencies** for better performance and security.
+- **Enhanced user prompts** for a more intuitive project setup.
+- **Switched to f-strings** replacing old `.format()` calls for improved readability.
+- **Simplified installation steps** by improving `README.md` structure.
+- **Improved GitHub Actions workflows** for automated testing and validation.
+
+### Fixed
+- **Resolved setup issues** related to module placement under `src/`.
+- **Fixed broken paths and URLs** in documentation.
+- **Ensured pre-commit hooks work as expected** with proper configurations.
+- **Addressed whitespace inconsistencies** in generated files.
+
+---
+
+[Unreleased]: https://github.com/at-gmbh/at-python-template/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/at-gmbh/at-python-template/releases/tag/v1.0.0

CONTRIBUTION.md

@@ -0,0 +1,81 @@
+# Contributing to AT Python Template
+
+We welcome your contributions! Whether it's reporting a bug, discussing ideas, submitting fixes, or proposing new features, we appreciate your input.
+
+## We Develop with GitHub
+We use GitHub to host code, track issues, and review pull requests.
+
+## Follow the GitHub Flow
+All changes should be proposed through pull requests:
+
+1. Fork the repository and create your branch from `master`.
+2. If you've added new functionality, include tests.
+3. Update the documentation if there are any changes to APIs or usage.
+4. Ensure all tests pass.
+5. Verify that your code adheres to linting and formatting standards.
+6. Submit your pull request!
+
+## Code License
+When you submit code changes, you agree that your contributions will be licensed under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+## Reporting Issues
+Please use [GitHub Issues](https://github.com/at-gmbh/at-python-template/issues) to report bugs and suggest improvements. Make sure to include:
+
+- A brief summary of the issue
+- Steps to reproduce the problem
+- Expected behavior
+- Actual behavior
+- Additional notes or related references
+
+## Coding Standards
+
+- Use 4 spaces per indentation level
+- Maximum line length is 120 characters
+- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guidelines
+- Use [Ruff](https://github.com/charliermarsh/ruff) for formatting and linting (applied automatically with pre-commit hooks, or manually if needed)
+- Include type hints as per [PEP 484](https://peps.python.org/pep-0484/)
+- Use Google-style docstrings
+- Ensure code is clean, readable, and maintainable
+
+## Imports
+
+- Order imports as follows:
+  1. Future imports
+  2. Standard library imports
+  3. Third-party imports
+  4. Local imports
+- Avoid wildcard imports
+- Use absolute imports unless relative imports simplify the code
+
+## Comments
+
+- Write comments in English
+- Explain the intention behind code, not what the code does
+- Use full sentences with proper capitalization and punctuation
+
+## Naming Conventions
+
+- Variables and functions: `lower_case_with_underscores`
+- Classes: `CapWords`
+- Constants: `ALL_CAPS_WITH_UNDERSCORES`
+- Modules: `alllowercase`
+
+## Setting Up for Development
+
+1. Install dependencies using `poetry install`.
+2. Run tests with `pytest tests`.
+3. Use `pre-commit install` to set up pre-commit hooks. This ensures that Ruff and other checks run before each commit.
+
+## Testing
+We use [pytest](https://docs.pytest.org/) for running tests. Ensure that all tests pass before submitting a pull request.
+
+## Additional Resources
+
+- [Cookiecutter Documentation](https://cookiecutter.readthedocs.io/)
+- [GitHub Flow Guide](https://guides.github.com/introduction/flow/)
+- [Python Packaging Guide](https://packaging.python.org/)
+- [Poetry Documentation](https://python-poetry.org/)
+- [Ruff Documentation](https://docs.astral.sh/ruff/)
+- [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html)
+
+Thank you for your contributions!