Metadata-Version: 2.4
Name: mppt
Version: 0.7.0
Summary: A Modern Python Package Template
Author-email: Xiangzhuang Shen <datahonor@gmail.com>
License: MIT
Project-URL: Homepage, https://shenxiangzhuang.github.io/mppt
Project-URL: Bug Tracker, https://shenxiangzhuang.github.io/mppt/issues
Project-URL: Documentation, https://shenxiangzhuang.github.io/mppt
Project-URL: Source Code, https://github.com/shenxiangzhuang/mppt
Project-URL: Release Notes, https://shenxiangzhuang.github.io/mppt/changelog/
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: ipython; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-sugar; extra == "dev"
Requires-Dist: hypothesis>=6.112.0; extra == "dev"
Requires-Dist: commitizen; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-material-extensions; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocs-bibtex; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mkdocs-autorefs; extra == "docs"
Requires-Dist: mkdocs-git-committers-plugin-2; extra == "docs"
Requires-Dist: mkdocs-git-revision-date-localized-plugin; extra == "docs"
Dynamic: license-file

# MPPT: A Modern Python Package Template

[![Python](https://img.shields.io/pypi/pyversions/mppt.svg?color=%2334D058)](https://pypi.org/project/mppt/)
[![PyPI](https://img.shields.io/pypi/v/mppt?color=%2334D058&label=pypi%20package)](https://pypi.org/project/mppt/)
[![PyPI Downloads](https://static.pepy.tech/badge/mppt)](https://pepy.tech/projects/mppt)
[![GitHub License](https://img.shields.io/github/license/shenxiangzhuang/mppt)](https://github.com/shenxiangzhuang/mppt/blob/master/LICENSE)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![Build Docs](https://github.com/shenxiangzhuang/mppt/actions/workflows/build_docs.yaml/badge.svg)](https://github.com/shenxiangzhuang/mppt/actions/workflows/build_docs.yaml)
[![Test](https://github.com/shenxiangzhuang/mppt/actions/workflows/test.yaml/badge.svg)](https://github.com/shenxiangzhuang/mppt/actions/workflows/test.yaml)
[![Codecov](https://codecov.io/gh/shenxiangzhuang/mppt/branch/master/graph/badge.svg)](https://codecov.io/gh/shenxiangzhuang/mppt)

## About

[MPPT](https://github.com/shenxiangzhuang/mppt): A **M**odern **P**ython **P**ackage **T**emplate.

## Get Started

1. Use this template repository to create your own project repository by clicking the "Use this template" button on GitHub or visiting [MPPT](https://github.com/shenxiangzhuang/mppt).

2. Replace all instances of MPPT, shenxiangzhuang, and other template-specific details with your own information:
   - Project name, author, and GitHub username in all files
   - GitHub repository links in README.md badges and documentation
   - Package name in pyproject.toml and code files
   - Update LICENSE file with your name and year

3. Set up your development environment:

   ```bash
   # Clone your repository
   git clone https://github.com/your-username/your-project.git
   cd your-project

   # Set up environment using uv
   uv venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate

   # Install development dependencies with uv
   uv sync --all-extras --dev

   # Initialize pre-commit hooks
   uv run pre-commit install
   ```

4. Start developing your package by modifying the code structure as needed.

5. Run tests to ensure everything is working correctly:

   ```bash
   uv run pytest
   ```

6. Preview documentation locally:

   ```bash
   uv run mkdocs serve
   ```

   Then visit [http://127.0.0.1:8000](http://127.0.0.1:8000) in your browser.

For more details on customization options, refer to the documentation.
