Skip to main content

A Python library template with build setup

Project description

Py Lib Template

A Python library template with modern packaging setup for PyPI publishing.

Installation

pip install py-lib-template

Usage

Basic Addition

from lib import add

# Add two numbers
result = add(1, 2)
print(result)  # 3

# Works with floats too
result = add(1.5, 2.5)
print(result)  # 4.0

Adding Multiple Numbers

from lib import add_many

# Add multiple numbers
result = add_many(1, 2, 3, 4, 5)
print(result.value)     # 15
print(result.operands)  # [1, 2, 3, 4, 5]

Development

Setup

# Create virtual environment
python -m venv venv

# Activate (Windows)
venv\Scripts\activate

# Activate (Unix/Mac)
source venv/bin/activate

# Install in development mode
pip install -e ".[dev]"

Build

# Build the package
python build_lib.py

# Or manually
python -m build --outdir pypi_publish

Test

pytest

Lint & Format

# Format code
black lib tests

# Lint
ruff lib tests

# Type check
mypy lib

Publish

# Build first
python build_lib.py

# Publish to PyPI (requires credentials)
cd pypi_publish
python -m twine upload *

Project Structure

py_lib_template/
├── lib/                    # Library source code
│   ├── __init__.py        # Package entry point
│   └── math_utils.py      # Example module
├── pypi_publish/          # Build artifacts (wheel, sdist)
├── tests/                 # Test files
├── pyproject.toml         # Package configuration
└── README.md

License

MIT

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

perry_py_lib_template-0.1.3.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

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

perry_py_lib_template-0.1.3-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

Details for the file perry_py_lib_template-0.1.3.tar.gz.

File metadata

  • Download URL: perry_py_lib_template-0.1.3.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for perry_py_lib_template-0.1.3.tar.gz
Algorithm Hash digest
SHA256 9658c606a09636b35475b4c92b5e83d5d205bd0aba4dc43943071d371fece14f
MD5 9ae15bcae0bc331cfe7d8f5b4b922669
BLAKE2b-256 81ff4fc06208aa665c4010d29f349f31abc19cdc28835ae283c80779af362219

See more details on using hashes here.

File details

Details for the file perry_py_lib_template-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for perry_py_lib_template-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 69737834fbd4c214aa0f2f078ce2eb1571f19de808a03add27b60a912cd9f54f
MD5 549730e8e695c20419c2cea4db0c4cf4
BLAKE2b-256 c875b8524c5d338395678c7f89e4adcb4e729b59b019f83487fd9bb16425658a

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