Skip to content

Instantly share code, notes, and snippets.

@hectorcanto

hectorcanto/README.template2.md

Last active August 17, 2025 10:37
Show Gist options
  • Save hectorcanto/8aff7d569e993e1079ab431b6b375e3f to your computer and use it in GitHub Desktop.
Save hectorcanto/8aff7d569e993e1079ab431b6b375e3f to your computer and use it in GitHub Desktop.
Download ZIP
This a README template which can be used as it is or rendering it with Copier or Jinja. It refers the main pillars of software development: Code, Testing, Documentation, Deployment, Observability, Data and Automation
Raw
README.template2.md

{{ project_title }}

Company Name

python3 since|2025/08

pipeline status coverage report Latest Release

[[TOC]]

Intro

This is a {{project_type}} {{_component_type}}

Documentation

Additional documentation

Related documentation

Architecture

Infrastructure

Stack

Installation

Usage

Configuration

Configuration is loaded using pydantic-settings.

Most values come from environmental variables injected through several mechanisme like secrets and pytest configuration.

Please, refer to gitlab-ci.yml for more information. Check also CI templates and Dockerfile.

Environment Variables

Testing

pytest
pytest -m unit
pytest -m "not instrumented"

Maintenance

Deployment

Observability

Baseline metrics

Operations

Troubleshooting

Contributors

  • {{ user_name | replace('-', ' ') | title }} - Creator

Use make git-contrib-first and make git-contrib-count, to get more information about contributors.

Potential improvements and future work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment