# CourseMap Python Package
Python bindings for the CourseMap tool - a Rust-based course dependency visualization tool.
## Installation
```bash
pip install coursemap
```
## Usage
### Python API
```python
import coursemap
# Generate course map
coursemap.generate_course_map("./courses", "map.svg", "svg")
# Generate inline SVG for Quarto
svg_content = coursemap.generate_inline_svg("./courses")
# Check Graphviz availability
if coursemap.check_graphviz_available():
print(coursemap.get_graphviz_info())
```
### Command Line
```bash
course-map -i courses -o map.svg -v
course-map --check-graphviz
course-map --inline -i courses
```
### Quarto Integration
```python
#| echo: false
import coursemap
# Generate and display course map
svg_content = coursemap.create_quarto_filter("../courses")
print(svg_content)
```
## Features
- Generate course dependency maps from Quarto/Markdown documents
- Support for SVG, PNG, and DOT output formats
- Inline SVG generation for Quarto documents
- Configurable styling and phases
- Graphviz integration
## License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "coursemap",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "quarto, markdown, course, dependency, visualization",
"author": null,
"author_email": "Kenji Sato <mail@kenjisato.jp>",
"download_url": "https://files.pythonhosted.org/packages/00/10/d5af77909da34284b809d4e3160748109743de5deaba17112dbeaac1ea99/coursemap-0.1.5.tar.gz",
"platform": null,
"description": "# CourseMap Python Package\n\nPython bindings for the CourseMap tool - a Rust-based course dependency visualization tool.\n\n## Installation\n\n```bash\npip install coursemap\n```\n\n## Usage\n\n### Python API\n\n```python\nimport coursemap\n\n# Generate course map\ncoursemap.generate_course_map(\"./courses\", \"map.svg\", \"svg\")\n\n# Generate inline SVG for Quarto\nsvg_content = coursemap.generate_inline_svg(\"./courses\")\n\n# Check Graphviz availability\nif coursemap.check_graphviz_available():\n print(coursemap.get_graphviz_info())\n```\n\n### Command Line\n\n```bash\ncourse-map -i courses -o map.svg -v\ncourse-map --check-graphviz\ncourse-map --inline -i courses\n```\n\n### Quarto Integration\n\n```python\n#| echo: false\nimport coursemap\n\n# Generate and display course map\nsvg_content = coursemap.create_quarto_filter(\"../courses\")\nprint(svg_content)\n```\n\n## Features\n\n- Generate course dependency maps from Quarto/Markdown documents\n- Support for SVG, PNG, and DOT output formats\n- Inline SVG generation for Quarto documents\n- Configurable styling and phases\n- Graphviz integration\n\n## License\n\nMIT License\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool to visualize course dependencies from Quarto/Markdown documents",
"version": "0.1.5",
"project_urls": {
"Documentation": "https://github.com/kenjisato/coursemap#readme",
"Homepage": "https://github.com/kenjisato/coursemap",
"Issues": "https://github.com/kenjisato/coursemap/issues",
"Repository": "https://github.com/kenjisato/coursemap"
},
"split_keywords": [
"quarto",
" markdown",
" course",
" dependency",
" visualization"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "57ed8329ba09f44011fce4d09b73e6de63108d9b51f72045e46797d6bddc80fd",
"md5": "30f290b7f06a00b68dcce3ce506633d8",
"sha256": "0e5e959c2fe9694a33eab2f9891c6fc5495b14f843d9df512dc75488765b7a0b"
},
"downloads": -1,
"filename": "coursemap-0.1.5-cp313-cp313-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "30f290b7f06a00b68dcce3ce506633d8",
"packagetype": "bdist_wheel",
"python_version": "cp313",
"requires_python": ">=3.8",
"size": 588742,
"upload_time": "2025-08-10T07:58:49",
"upload_time_iso_8601": "2025-08-10T07:58:49.708482Z",
"url": "https://files.pythonhosted.org/packages/57/ed/8329ba09f44011fce4d09b73e6de63108d9b51f72045e46797d6bddc80fd/coursemap-0.1.5-cp313-cp313-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0010d5af77909da34284b809d4e3160748109743de5deaba17112dbeaac1ea99",
"md5": "ed7b42136003f89cd279f891b8abf799",
"sha256": "0bc7386e6dba5ab993b69ab2548f2c13ea11c1daa615d46121707dd660eca79e"
},
"downloads": -1,
"filename": "coursemap-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "ed7b42136003f89cd279f891b8abf799",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 81333,
"upload_time": "2025-08-10T07:58:51",
"upload_time_iso_8601": "2025-08-10T07:58:51.388567Z",
"url": "https://files.pythonhosted.org/packages/00/10/d5af77909da34284b809d4e3160748109743de5deaba17112dbeaac1ea99/coursemap-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-10 07:58:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kenjisato",
"github_project": "coursemap#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "coursemap"
}
JSON
