COVESA / COVESA/s2dm

🔧 Refactor Project Structure

Open
#84 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement invalid
Dominant language
Python
Stars
17
Forks
10
Avg merge
1d 10h
Merged PRs (30d)
2

Description

### 🧭 Summary

The current file structure of the `s2dm` project has grown without a consistent layout, making it harder to navigate and extend. We propose a refactor to align with **Python best practices** for CLI-based tools and to improve support for:

- Modular commands
- Reusable business logic
- Documentation generation via Hugo (`docs-gen/`)
- Clean testing and packaging

---

### ✅ Goals

- Consolidate all source code inside a proper Python package (`s2dm/`)
- Separate CLI entry points, core logic, and utilities
- Keep `docs-gen/` cleanly separated for Hugo-based documentation
- Improve readability and maintainability of the codebase
---

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.