Skip to content

Commit

Permalink
chore: update README and fefactor PyPI guide; increment version to 3.…
Browse files Browse the repository at this point in the history
…3.0; add todo doc
  • Loading branch information
shaneholloman committed Sep 24, 2024
1 parent 48dc9d1 commit c2e14d3
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 8 deletions.
8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions notes/complete-pypi-publication-guide.md → notes/pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
42 changes: 42 additions & 0 deletions notes/todo.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion src/codemapper/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit c2e14d3

Please sign in to comment.