Skip to main content

WIP placeholder (not ready for use): opinionated Copier template for Python projects (pre-beta).

Project description

python-foundry Copier Template (Pre-Beta)

WIP / NOT READY FOR USE

This project is a work in progress. It is published as a pre-beta placeholder primarily to reserve the name on PyPI. Do not use it for real projects yet.

An opinionated Copier template for Python projects that bakes in a smooth dev loop: Make for common tasks, Ruff + MyPy for quality, Pytest for tests, Nox for automation, MkDocs for docs, and ready-to-use AI prompt helpers.

Status: pre-beta — interfaces and defaults will change. Expect breaking updates until v0.1.0. Note: This PyPI package (python-foundry) does not provide a runtime Python module.

Highlights

  • Copier-first scaffolding with sensible defaults
  • uv for fast, reproducible installs and builds
  • Ruff + MyPy for fast linting and typing
  • Pytest wired for speedy feedback
  • Nox sessions to standardize local/CI runs
  • MkDocs for documentation out of the box
  • Make shortcuts for format, lint, test, docs, release
  • AI prompts to guide common maintenance and release tasks

Quick start (template consumers)

Not available yet.

This section will be filled in once the template is usable.

Development (template maintainers)

  • Run make fmt then make lint to keep code clean.
  • Use nox -s tests for the canonical test suite.
  • Build docs locally with make docs-serve (MkDocs live reload).
  • When ready for a pre-release, update pyproject.toml metadata and CHANGELOG.md, then publish via make release (to be scripted).

AI prompt helpers

A curated set of prompts will live under docs/ai-prompts/ to speed up fixes, reviews, and releases. These will expand as the template matures.

Status and support

This template is still stabilizing. Please open issues with clear repro steps and share your environment details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_foundry-0.1.0a1.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_foundry-0.1.0a1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file python_foundry-0.1.0a1.tar.gz.

File metadata

  • Download URL: python_foundry-0.1.0a1.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for python_foundry-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 f78460c70cdd289dacbd30a13d4fd3b97bc01f4be88959a31e27ee748edb36bb
MD5 12807082d18dc3e8be056984d8d5591b
BLAKE2b-256 2f28f2712e77b9aa42da120f619b326fd1046bce6cf0b05376bc5f40c127ab7a

See more details on using hashes here.

File details

Details for the file python_foundry-0.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for python_foundry-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 c44960e6a9d7119850dc91807946bd3703f98046392a73521f51d0ea02482a98
MD5 b832fb84694ddb07b7fcaadfbd665bc3
BLAKE2b-256 e44c6b3097935093fe4c32a4f0d56511cda12be981e0c4279c09545171aa9ef5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page