README.md

MPPT: A Modern Python Package Template

About

MPPT: A Modern Python Package Template.

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.

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:

   # 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:

   uv run pytest

6. Preview documentation locally:

   uv run mkdocs serve

   Then visit http://127.0.0.1:8000 in your browser.

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