Skip to main content

pup-core: Professional Python Project Tools: Core Library

PyPI Docs Site Repo Python 3.15 License

CI Docs-Deploy Pre-Release Release Links Dependabot

pup logo

Shared core library for opinionated professional Python project tools.

Purpose

This library centralizes functionality across tools, including:

  • repository root and project detection
  • pyproject.toml inspection
  • Python package and source-layout detection
  • notebook detection
  • Python version normalization
  • project and package name normalization
  • safe repository-relative path handling
  • Git and repository metadata inspection
  • managed file-section detection and manipulation
  • shared immutable types and errors

pup-core contains shared mechanisms rather than project policy.

The user-facing tools determine what should happen:

  • pup-up synchronizes professional project scaffolding with managed templates.
  • pup-check verifies that a project is internally consistent.
  • pup-tidy removes known generated artifacts when preparing teaching repositories for release.

Professional Python Project Tools

Template Source

Developer Command Reference

Show command reference

In a machine terminal

Open a machine terminal where you want the project:

git clone https://github.com/denisecase/pup-core

cd pup-core
code .

In a VS Code terminal

uv self update
uv python pin 3.15
uv lock --upgrade
uv sync --upgrade

uv run pre-commit install
uv run pre-commit autoupdate

git add -A
uv run pre-commit run --all-files
# repeat if changes were made
uv run pre-commit run --all-files

# types, tests, docs
uv run python -m pyright
uv run python -m pytest
uv run python -m zensical build

# save progress
git add -A
git commit -m "update"
git push -u origin main

Documentation

Annotations

.annotations/annotations.md

Citation

CITATION.cff

License

MIT

Download files

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

Source Distribution

pup_core-0.0.5.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

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

pup_core-0.0.5-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file pup_core-0.0.5.tar.gz.

File metadata

  • Download URL: pup_core-0.0.5.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pup_core-0.0.5.tar.gz
Algorithm Hash digest
SHA256 c14232dbcd028800c61950e6842b0c9056ab495e34e06e56c1f0d5512c7493bf
MD5 82d05ee94fc9b86f8e7fb92654a00f72
BLAKE2b-256 e778524abea6495f228c5ee279af5a4b81eecbcbfd550822d7822d772fbc1891

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_core-0.0.5.tar.gz:

Publisher: release-pypi.yml on denisecase/pup-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pup_core-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: pup_core-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pup_core-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 afe74219b763c7a65bfc642619b97f9521950acc1ad455d0751d272730a9895f
MD5 84fda46d1a73c799ec40e48151d23dac
BLAKE2b-256 fff72e8d96c77aa097c43311c80eb34af6a0b440a4c3e37e4712c5fbb363b270

See more details on using hashes here.

Provenance

The following attestation bundles were made for pup_core-0.0.5-py3-none-any.whl:

Publisher: release-pypi.yml on denisecase/pup-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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