Milestones
List view
# Overview This milestone focuses on streamlining the OpenPlaceRecognition codebase and modernizing its dependency setup. The goal is to reduce unnecessary bloat, make important dependencies more manageable, and ensure the library can be easily installed and tested in multiple environments. **Sequential Tasks Notice**: The Issues in this milestone are designed to be completed in a specific order. Some tasks are blocked by earlier ones, ensuring a smooth workflow and preventing rework. Check for the `blocked` label or references in each Issue to see which tasks need to happen first. # Scope of Work 1. **Remove Redundant Code** - Identify and eliminate code blocks or modules that are no longer used or maintained. 2. **Make Heavy & Rarely Used Dependencies Optional** - For example, make **PaddlePaddle** optional, since it’s only relevant to a single, specialized pipeline. 3. **Set Up Poetry for Dependency Management** - Transition from the current dependency approach to [Poetry](https://python-poetry.org/) for streamlined installation and version tracking. 4. **Define Minimum Version Requirements** - Determine the lowest supported versions for each dependency without breaking existing functionality. 5. **Revamp Testing Strategy** - Remove existing, outdated tests. - Write basic tests from scratch to ensure core functionality works. - Implement an environment test framework (e.g., **Nox**) to verify compatibility across multiple Python versions or OS environments. 6. **Improve Installation Experience** - Ensure the library can be installed via a simple `pip install .`, making it more accessible to end users. # Success Criteria - **No redundant code** remains in the repository. - **Optional dependencies** are properly documented and do not install unless explicitly requested. - **Poetry configuration** is in place, with clear version constraints. - **Basic test suite** passes in multiple environments (e.g., different Python versions) without errors. - **Pip installation** works seamlessly for all core functionality. # Target Completion - **End of Q2** This milestone lays a foundation for future improvements and fosters a more welcoming environment for contributors and users alike. Once these tasks are complete, the project should be leaner, easier to maintain, and friendlier to community contributions.
Overdue by 1 year(s)•Due by June 27, 2025•5/11 issues closed