python-lib-template

A template project for Python 3.11 library projects which includes:

• pytest
• black
• isort
• PEP 517 metadata build

Quickstart

# create virtual environment and execute tests
python3 -m venv venv && \
        source venv/bin/activate && \
        python3 -m pip install --upgrade pip setuptools
        
python3 -m pip install -e .[dev]

python3 -m pytest

Using the Template

• clone the repository for your specific project git clone <url> <your project name>
• rename the toplevel namespace and package directories
• update setup.cfg to reflect project naming as appropriate
• update logging.yml to utilize the project's namespace/packaging as appropriate
• review [setup.cfg](PEP 517 metadata build) for additional settings