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.2.tar.gz (5.2 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.2-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: perry_py_lib_template-0.1.2.tar.gz
  • Upload date:
  • Size: 5.2 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.2.tar.gz
Algorithm Hash digest
SHA256 b5436e0f9f1eb76aa46b77ef374cb3147fd2ea7430e9b30e6743a1322f8627b1
MD5 0614ee6cbafd2c0b025baba12f1b3aee
BLAKE2b-256 2e4023e5cb65d062e86574e2f3010dd85ae6951ed9aeeabaf0ff928ef7c99e5d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for perry_py_lib_template-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3552385f59f1f2cf979e563c6f697dd3dc36203534b67d0bd394a225c980920f
MD5 1dd860c8afdb008ccfb1fd3aba23307d
BLAKE2b-256 e280e3dc78f01f89f2f57b02ceb44c88c7f3c38f9434d569ee1e9219e4e9ad9c

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