Welcome to NEMDataTools documentation
Developer Guide
- NEMDataTools Project Board
- Phase 1: Project Setup (Milestones 1-2) ✅ COMPLETED
- Phase 2: Core Functionality Implementation (Milestones 3-4)
- Phase 3: Data Processing (Milestones 5-6)
- Phase 4: Documentation and Examples (Milestone 7)
- Phase 5: Quality Assurance and Release (Milestone 8)
- Phase 6: Continuous Improvement (Ongoing)
- Development Practices
- NEMDataTools Implementation Status
- Quick Start Guide: Setting Up NEMDataTools with UV
- Prerequisites
- Step 1: Install UV
- Step 2: Clone and Setup the Project
- Step 3: Create and Activate Virtual Environment
- Step 4: Setup Configuration Files
- Step 5: Install Dependencies with UV
- Step 6: Implement Core Modules
- Step 7: Run Tests
- Step 8: Code Formatting and Linting
- Step 9: Build Documentation
- Automation Script
- Next Steps
- Using UV for Dependency Management in NEMDataTools
- Adding pre-commit to NEMDataTools
- Step 1: Update
pyproject.tomlto include pre-commit - Step 2: Install pre-commit using UV
- Step 3: Create a pre-commit configuration
- Step 4: Install the pre-commit hooks
- Step 5: Run pre-commit manually (optional)
- Using pre-commit with UV
- Integration with your development workflow
- Customizing pre-commit configuration
- Commit message convention with commitizen
- Troubleshooting pre-commit
- Additional Tips
- Step 1: Update
- Commitizen Conventional Commit Guide