mylibrary-edison 0.1.0

A complete professional Python library project ready for PyPI

mylibrary-edison

A clean, modern, and production-ready Python library boilerplate, packaged with the latest PEP standards using pyproject.toml and ready to be published to PyPI.

---

Table of Contents

• Features
• Installation
• Usage
• Project Structure
• Developer Guide
  • Local Development Setup
  • Testing
  • Building the Package
  • Publishing to PyPI
• GitHub Actions CI/CD
• License

---

Features

• Modern Packaging: Configured using standard pyproject.toml with setuptools.
• Clean Structure: Exposes a clear public interface at the package level.
• Production Ready: Includes setup scripts, test structure, and automated publishing workflows.
• Beginner Friendly: Well-documented codebase with simple CLI recipes.

---

Installation

Install the library directly from PyPI using pip:

pip install mylibrary-edison

---

Usage

Once installed, you can import and use the library in your Python projects:

from mylibrary import answer

# Call the placeholder function
answer()

---

Project Structure

Here is an overview of the directory structure and what each file does:

mylibrary/
├── .github/
│   └── workflows/
│       └── publish.yml       # GitHub Actions workflow for automatic publishing to PyPI on release tags.
├── mylibrary/                # Main package directory.
│   ├── __init__.py           # Package entrypoint, handles public exports.
│   └── core.py               # Core logic and helper functions.
├── tests/                    # Unit and integration test suite.
│   ├── __init__.py
│   └── test_core.py          # Tests targeting core functionality.
├── .gitignore                # Patterns for Git to ignore.
├── LICENSE                   # MIT License text.
├── pyproject.toml            # Modern project metadata and build configuration.
└── README.md                 # Project documentation (this file).

---

Developer Guide

Local Development Setup

To work on the library locally, it is recommended to create a virtual environment and perform an editable install. This allows you to test your changes in real-time.

1. Create and activate a virtual environment:

   python3 -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   

2. Install the package in editable mode with development dependencies:

   pip install --editable .[dev]
   

   (Note: If you add test dependencies, you can specify them in pyproject.toml under optional-dependencies. For now, you can also just run pip install pytest build twine.)

Testing

This project uses pytest for testing.

1. Install testing tools:

   pip install pytest
   

2. Run the test suite:

   pytest
   

Building the Package

To package the project into source distributions and wheels for PyPI:

1. Install the build tool:

   pip install --upgrade build
   

2. Build the distributions:

   python -m build
   

   This will generate a source archive .tar.gz and a built wheel .whl inside the dist/ directory.

Publishing to PyPI

Once the package is built, you can upload it to PyPI using twine.

1. Install Twine:

   pip install --upgrade twine
   

2. Validate the built package:

   python -m twine check dist/*
   

3. Upload to TestPyPI (Recommended first step to verify):

   python -m twine upload --repository testpypi dist/*
   

4. Upload to PyPI (Production):

   python -m twine upload dist/*
   

---

GitHub Actions CI/CD

An automated release workflow is configured in .github/workflows/publish.yml. When you push a Git tag matching v* (e.g. v0.0.1), the workflow will automatically:

1. Set up the Python environment.
2. Build the package distribution.
3. Securely publish it to PyPI using PyPI's Trusted Publishing mechanism (OIDC).

---

License

This project is licensed under the MIT License - see the LICENSE file for details.