Metadata-Version: 2.4
Name: swecc-pypi-template
Version: 0.1.1
Summary: A template for creating a Python package and publishing it to PyPI
Project-URL: Homepage, https://github.com/swecc/swecc-pypi-template
Project-URL: Documentation, https://github.com/swecc/swecc-pypi-template#readme
Project-URL: Issues, https://github.com/swecc/swecc-pypi-template/issues
Author-email: SWECC Labs <swecc@uw.edu>
License-Expression: MIT
License-File: LICENSE
Keywords: packaging,pypi,template
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Provides-Extra: dev
Requires-Dist: black; extra == 'dev'
Requires-Dist: build; extra == 'dev'
Requires-Dist: mkdocs; extra == 'dev'
Requires-Dist: mkdocs-material; extra == 'dev'
Requires-Dist: mkdocstrings[python]; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-asyncio; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: types-click; extra == 'dev'
Requires-Dist: types-markdown; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Requires-Dist: types-requests; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Provides-Extra: lint
Requires-Dist: black; extra == 'lint'
Requires-Dist: mypy; extra == 'lint'
Requires-Dist: pre-commit; extra == 'lint'
Requires-Dist: ruff; extra == 'lint'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Description-Content-Type: text/markdown

# SWECC pypi template

Get up and running quickly with a new python package.

1. Rename [`./swecc_pypi_template`](./swecc_pypi_template) to whatever your package is named
2. Find and replace `./swecc_pypi_template` and `swecc-pypi-template`
3. Optionally change the python versions in [`./pyproject.toml`](./pyproject.toml) and [`.github/workflows/ci.yml`](.github/workflows/ci.yml)

### Dev Setup

```bash
python -m venv venv
source venv/bin/activate
pip install -e ".[dev]"
pre-commit install
```

### Commands

```bash
# lint
ruff check swecc_pypi_template

# format
black swecc_pypi_template

# type check
mypy swecc_pypi_template

# test
pytest
```

