Skip to main content

Test Python library

Project description

Py Lib Template

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

Create your own libraries in the lib folder, using the py_lib_template example, you can create your own library by changing the name of the folder and update the folder name in the pyproject.toml file. Follow the steps below for more details

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
pip install build
pip install twine

Pre-Build

  • In pyproject.toml. Update the version and name of the library that you wish to publish.

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

lib/
├── py_lib_template/                    # 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

regex_str_checker_test-0.1.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

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

regex_str_checker_test-0.1.0-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file regex_str_checker_test-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for regex_str_checker_test-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3b6b7d48ab5e5a6ca84baaa4627f84ee2be5403635aaf46ca11c9fe43799c9fb
MD5 17dfe63d98bc0049b1e6481def97e614
BLAKE2b-256 c76f31024d3c851fc0605302ff58445e6193ee863a55e31d430c526992dbce82

See more details on using hashes here.

File details

Details for the file regex_str_checker_test-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for regex_str_checker_test-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 adcacb27443f6b076ca0f5fb51942783ca23d83aa2992f211c11716858553565
MD5 35b29822d7479c4e5fc7ae94e2b4ddf5
BLAKE2b-256 c980e591bf06e6766981aec3b5a8447c682c90dbc5b4748431af78609f3341c8

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