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.

Links

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.0a2.tar.gz (3.4 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.0a2-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_foundry-0.1.0a2.tar.gz
  • Upload date:
  • Size: 3.4 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.0a2.tar.gz
Algorithm Hash digest
SHA256 2ad12c0a83e9bb7c61ba924402b1a852ecc69a9412587b87b2b99e3a0bc91981
MD5 86487af9bef1c0f0f13b9bf8eb93de6c
BLAKE2b-256 4d52e16bc4d722b1380db2e6ae43246d87fcb60d57ee274d674d069be67fa3aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_foundry-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 20dc598e17c6c4d24b4a526a7e70b689d8456b39c8613750e70bc6c15ba8fbfb
MD5 30ef5134ac0d44af8c8c3aaef8ed03c0
BLAKE2b-256 81797d7e29d7382b2a8bc6032d240a0a1a31e8d56c2e13cad48de932b3e08ac1

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