diff --git a/README.md b/README.md index fb2de3d..f4dcf75 100644 --- a/README.md +++ b/README.md @@ -115,13 +115,7 @@ codemapper https://github.com/shaneholloman/ansible-role-apache ## TODO -- [x] Add support for creating directly from repo url -- [ ] Implement a clever way to include images in the artifacts, maybe base64 encode them directly to the markdown file, but that could chew thru tokens at prompt time? Suggestions? -- [ ] Add support for other Git hosting services (e.g., GitLab, Bitbucket) -- [ ] Implement a progress indicator for cloning/analyzing large repositories -- [x] Table of Contents in some cases needs improvement. We may add some ignores - - [ ] For TOC consider a more robust library like `md_toc` no user complaints yet -- [x] Use changelog.md for version history +![codemapper todo list is here](./notes/todo.md) ## Contributing diff --git a/notes/complete-pypi-publication-guide.md b/notes/pypi.md similarity index 98% rename from notes/complete-pypi-publication-guide.md rename to notes/pypi.md index 7260281..aead25d 100644 --- a/notes/complete-pypi-publication-guide.md +++ b/notes/pypi.md @@ -135,6 +135,8 @@ git pull origin main 11.7. Rebuild the package: +I typically delete to the old build files before rebuilding. + ```bash python setup.py sdist bdist_wheel ``` diff --git a/notes/todo.md b/notes/todo.md new file mode 100644 index 0000000..8221749 --- /dev/null +++ b/notes/todo.md @@ -0,0 +1,42 @@ +# CodeMapper TODO List + +## Core Functionality + +- [x] Implement direct repository URL analysis +- [ ] Expand Git hosting service support (GitLab, Bitbucket) +- [ ] Develop progress indicator for large repository processing +- [ ] Enable custom branch selection +- [ ] Implement intelligent repository categorization + - [ ] Deterministic analysis + - [ ] AI-powered analysis + - [ ] Add option to update original repo with categories (for owners) + +## Documentation + +- [x] Utilize changelog.md for version tracking +- [ ] Create separate `*_docmap.md` for documentation directories +- [ ] Add repository source information to output file header + +## AI Integration + +- [ ] Implement AI-generated alt text for images +- [ ] Explore base64 image encoding and embedding + +## Output Formats + +- [x] Markdown (default) +- [ ] JSON +- [ ] YAML +- [ ] reStructuredText +- [ ] AsciiDoc + +## User Experience + +- [ ] Develop comprehensive help command and menu +- [ ] Enhance Table of Contents generation + - [ ] Consider using `md_toc` library for robustness +- [ ] EPIC: Introduce Mermaid flow chart option for code execution flow visualization + +## File Handling + +- [x] Generate `*_codemap.md` for file contents and directory structure diff --git a/src/codemapper/__init__.py b/src/codemapper/__init__.py index b6449c8..53ceb90 100644 --- a/src/codemapper/__init__.py +++ b/src/codemapper/__init__.py @@ -6,6 +6,6 @@ creating detailed Markdown documentation of their structure and contents. """ -__version__ = "3.2.3" +__version__ = "3.3.0" # Any other necessary imports or package-level code can go here