Skip to main content

Your lib name

Overview

🚧 Clear brief of your lib

Python versions support

🚧 The required Python versions of this library

[![Supported Versions](https://img.shields.io/pypi/pyversions/.svg?logo=python&logoColor=FBE072)](https://pypi.org/project/)

Quickly Start

🚧 The details of quickly start as simple demonstration for users

Documentation

🚧 The details of documentation ...

Reusable GitHub Actions Workflows & Actions

This template provides a comprehensive set of reusable GitHub Actions workflows and actions that can be called from other repositories to standardize CI/CD operations. Projects using this template can leverage these centralized components for consistent automation.

🚀 Key Features

  • Centralized Management: All workflows and actions are maintained in this template repository
  • Standardized Operations: Consistent CI/CD processes across all projects
  • Easy Integration: Simple calls using external repository references
  • Comprehensive Coverage: Testing, building, releasing, Docker operations, documentation, and setup utilities

📋 Available Workflows

Workflow Purpose Key Features
rw_build_and_test.yaml Run comprehensive test suite Unit, integration, e2e, contract tests
rw_run_all_test_and_record.yaml Complete CI with reporting CodeCov upload, SonarCloud analysis
rw_python_package.yaml Python package operations Build, test, publish to PyPI
rw_docker_operations.yaml Docker operations Build, test, push, security scanning
rw_parse_release_intent.yaml Release configuration parser Determines release components
rw_build_git-tag_and_create_github-release_v2.yaml Git tagging and releases Automated version management
rw_docs_operations.yaml Documentation operations Build, version, deploy docs

📦 Available Actions

Action Purpose Key Features
setup-python-uv Python & UV setup with dependencies Multi-version support, intelligent caching, flexible dependency groups

🔧 Quick Start

To use these reusable workflows in your project, simply call them using external repository references:

# .github/workflows/ci.yaml in your project
name: CI
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  test:
    uses: Chisanan232/Template-Python-UV-Project/.github/workflows/rw_run_all_test_and_record.yaml@master
    secrets:
      codecov_token: ${{ secrets.CODECOV_TOKEN }}
      sonar_token: ${{ secrets.SONAR_TOKEN }}

📚 Complete Documentation

  • Reusable Workflows Guide: Complete documentation with all inputs, outputs, and usage examples
  • Example Workflows: Ready-to-use example workflows for common scenarios
  • Template Placeholders: All workflows use <your_*> placeholders for easy customization

💡 Benefits for Projects Using This Template

  1. Reduced Boilerplate: No need to write complex CI/CD workflows from scratch
  2. Best Practices: Workflows follow established patterns and security practices
  3. Automatic Updates: Bug fixes and improvements are centrally maintained
  4. Consistency: Same workflow behavior across all projects using the template
  5. Easy Maintenance: Update workflows in one place, benefits all projects

Coding style and following rules

follows coding styles black and PyLint to control code quality.

Code style: black linting: pylint

Downloading state

🚧 The download state for your library

[![Downloads](https://pepy.tech/badge/)](https://pepy.tech/project/) [![Downloads](https://pepy.tech/badge//month)](https://pepy.tech/project/)

License

MIT License

Metadata

Release files for test-python-uv-project-template 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for test-python-uv-project-template 0.0.3
File Size Uploaded Provenance
test_python_uv_project_template-0.0.3.tar.gz 11.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for test-python-uv-project-template 0.0.3
File Interpreter ABI Platform
test_python_uv_project_template-0.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 29.0 kB

Release files / test_python_uv_project_template-0.0.3.tar.gz

Download URL test_python_uv_project_template-0.0.3.tar.gz
Size 11.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0872b8d51dae9cda4d0759424c640975340e476845c327f35f6afc4e6cb39077
BLAKE2b-256 checksum
How to use checksums
98ac40020e50989fbe1c48a44b3c4aa3f2862d1e168d2ae50c970d6a4a243642
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.22

Release files / test_python_uv_project_template-0.0.3-py3-none-any.whl

Download URL test_python_uv_project_template-0.0.3-py3-none-any.whl
Size 17.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fcb158f178cfcada806936c6e32076d76471411c2120fd275cea66465e21dbb2
BLAKE2b-256 checksum
How to use checksums
95294bd30d1dad3c784825e8d344e9f4a884b05e8888f52fde933ed87c213dc4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.22

Security for test-python-uv-project-template 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page