PythonTemplateIt 0.5.0

Template for new Python projects.

PythonTemplateIt

Category	Status and Links
General
CD/CI
PyPI
Github

Template for Python projects with standardized tooling, automation scripts, and reusable GitHub workflows.

---

Overview

This repository is a starter template for Python services in the BrightEdgeeServices and RealTimeEvents ecosystem. It provides a baseline for packaging, linting, testing, environment provisioning, and release automation.

---

Requirements

• Python 3.12+
• Poetry
• Docker (optional, for local MySQL service)
• Pre-commit
• GitHub access token(s) for private dependency repositories

---

Quick Start

# 1) Prepare local environment variables
.\SetupDotEnv.ps1

# 2) Configure private dependency access
.\SetupPrivateRepoAccess.ps1

# 3) (Optional) Configure GitHub CLI access for repository tasks
.\SetupGitHubAccess.ps1

# 4) Install project and dev dependencies
.\InstallDevEnv.ps1

# 5) Start local database (optional)
docker compose up -d db

# 6) Run tests
poetry run pytest

---

Script Overview

• Install.ps1: Initializes Poetry tooling and installs dependencies.
• InstallDevEnv.ps1: Installs dev dependencies, syncs Poetry environment, and updates pre-commit hooks.
• SetupDotEnv.ps1: Generates a .env file from current environment variables.
• SetupPrivateRepoAccess.ps1: Configures Poetry sources and credentials for private repositories.
• SetupGitHubAccess.ps1: Configures GitHub authentication for local automation tasks.
• SetUpDocker.ps1: Installs and configures Docker support on development machines.
• CreateDbSqlScript.ps1: Creates SQL bootstrap script for local MySQL setup.

---

Release Notes Update Process

1. Commit the current implementation or stage all intended release changes.

2. Compare the current branch against master:

   git rev-parse --abbrev-ref HEAD
   git diff --name-status master...HEAD
   git diff --shortstat master...HEAD
   

3. Add a new top section in ReleaseNotes.md using grouped headings, a timestamp, and summary statistics. Git-tracked diffs already exclude .gitignore entries.

4. Update the package version in pyproject.toml using SemVer.

5. Push changes and create a PR.

---

Active Workflows

• .github/workflows/py-temp-pr-pub-no_docker-def.yaml: Pull request validation workflow.
• .github/workflows/py-temp-publish-pub-build_release_notify_after_merge-def.yaml: Release build/publish and notification on merge to master.