codeannex 0.1.1__py3-none-any.whl

codeannex-0.1.1.dist-info/METADATA

@@ -0,0 +1,147 @@
+Metadata-Version: 2.4
+Name: codeannex
+Version: 0.1.1
+Summary: Generates a professional PDF source code annex with Smart Index, Images and Emoji support.
+License: MIT
+Project-URL: Repository, https://github.com/tanhleno/codeannex
+Keywords: pdf,source-code,documentation,annex,reportlab,emoji
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: reportlab>=4.0
+Requires-Dist: Pillow>=10.0
+Requires-Dist: Pygments>=2.16
+Requires-Dist: pdfminer.six>=20231228
+Provides-Extra: svg
+Requires-Dist: cairosvg>=2.7; extra == "svg"
+Requires-Dist: svglib>=1.5; extra == "svg"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# 📂 codeannex
+
+Generates a professional PDF annex from a project's source code — with syntax highlighting, a clickable table of contents, image rendering, non-selectable line numbers, and configurable fonts.
+
+## Features
+
+- **Syntax highlighting** via Pygments (Catppuccin Mocha theme)
+- **Clickable table of contents** with page numbers (two-pass layout)
+- **Smart word wrap** — breaks at word boundaries, respects emoji codepoints
+- **Non-selectable line numbers** rendered as images
+- **Image support** — embeds PNG, JPG, GIF, WebP, BMP, ICO, and SVG files
+- **Git-aware** — uses `git ls-files` when available; falls back to manual `.gitignore` parsing
+- **Cross-platform font discovery** — finds monospace and emoji fonts on Windows, macOS, and Linux
+- **Emoji support** — configurable fonts for emojis, with fallback for better rendering.
+  - *Tip for Linux:* Install `fonts-symbola` for high-coverage monochromatic emoji support that works reliably with ReportLab.
+- **Emoji descriptions** — option to print `[EMOJI NAME]` instead of glyphs for systems without emoji fonts.
+- **Configurable fonts** — customize normal, bold, monospace, and emoji fonts.
+- **Page numbering** — customizable font size and position.
+- **Repository Link** — show a clickable repository link on the cover page.
+- **Fast binary file detection** — quickly ignores common binary extensions.
+
+## Requirements
+
+- Python >= 3.11
+- `reportlab`, `Pillow`, `Pygments`
+
+Optional SVG rendering (install at least one):
+- `cairosvg` (preferred)
+- `svglib`
+
+For development and testing:
+- `pytest` (install with `pip install -e ".[dev]"`)
+
+## Installation
+
+```bash
+pip install codeannex
+```
+
+With SVG support:
+
+```bash
+pip install "codeannex[svg]"
+```
+## Requirements
+
+- Python >= 3.11
+- `reportlab`, `Pillow`, `Pygments`, `pdfminer.six`
+
+Optional SVG rendering (install at least one):
+...
+## Usage
+
+```bash
+# Annotate current directory
+codeannex
+
+# Annotate a specific project
+codeannex /path/to/project
+
+# Custom output filename
+codeannex /path/to/project -o my_annex.pdf
+
+# Customized configuration (margins in cm)
+codeannex /path/to/project \
+  --name "My Project" \
+  --repo-url "https://github.com/user/repo" \
+  --margin 1.5 \
+  --margin-top 2.5 \
+  --page-number-size 10 \
+  --show-project
+```
+
+### Configuration Options
+
+- `--name NAME` — Custom project name (default: directory name).
+- `--repo-url URL` — Repository URL to show as a clickable link on the cover.
+- `--start-page N` — Starting page number (default: 1).
+- `--margin CM` — General margin in cm for all sides.
+- `--margin-left CM` — Left margin in cm (default: 1.5).
+- `--margin-right CM` — Right margin in cm (default: 1.5).
+- `--margin-top CM` — Top margin in cm (default: 2.0).
+- `--margin-bottom CM` — Bottom margin in cm (default: 2.0).
+- `--show-project` — Show project name in page footer (default: off).
+- `--page-number-size N` — Font size for page numbers (default: 8).
+- `--normal-font FONT` — Font for normal text (default: Helvetica).
+- `--bold-font FONT` — Font for bold text (default: Helvetica-Bold).
+- `--mono-font FONT` — Monospace font for code (default: auto-detect).
+- `--emoji-font FONT` — Font for emojis (default: auto-detect).
+- `--emoji-description` — Print `[DESCRIPTION]` instead of emoji glyphs.
+- `--check-emoji-font` — Check current emoji font style and exit.
+
+
+## Testing
+
+Run the test suite with pytest:
+
+```bash
+pytest
+```
+
+## Output
+
+The generated PDF contains:
+
+1. **Cover page** — project name with page number
+2. **Table of contents** — tree-structured, with clickable links to each file
+3. **File pages** — syntax-highlighted source, with file path headers and line numbers
+
+Files are ordered: root files first (alphabetical), then directories recursively (alphabetical).
+
+Binary files (e.g., .pdf, .exe) are automatically ignored with warnings if not in .gitignore.
+
+## License
+
+MIT

codeannex-0.1.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+codeannex/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codeannex/__main__.py,sha256=_4uZKaXNXOEnFBXVbpBV0GbQH5nKGck4thDzs7Kr-O0,6882
+codeannex/config.py,sha256=SjvoOLbyoboe7vQWzCKG0T0dOxTyYgCpnRcdvyiBns4,2853
+codeannex/file_utils.py,sha256=ABo5fZXSjx56iRuH0secM_9kHu2uHUBY1KZp8HiXRr0,4423
+codeannex/fonts.py,sha256=rGb_iEebovAYrhHdk83tU0EviqEHIpfzYZPi-_xVgII,9624
+codeannex/highlight.py,sha256=3wAXeFn2d60YY4W9GIXtC0r5QxNjPTOtyKWeHo0MBZA,602
+codeannex/pdf_builder.py,sha256=FEf-s-h8YnKWpVZ5no4MHRlYi6sHfRRAlm9RafKEXPk,20600
+codeannex/text_utils.py,sha256=tgIH5Qtu3hAswUHkipnWf6-LMV3b2Mt6IPgv7Po7AOM,5380
+codeannex-0.1.1.dist-info/licenses/LICENSE,sha256=gfz2fEQx_KbzZUIsJMctbuixaITXXl9_Q6uKuoB5Sl0,1083
+codeannex-0.1.1.dist-info/METADATA,sha256=WBTcK1A-8Os7PjBnZCX2q2lwqmUoFnjpchY_FeD1KqM,5094
+codeannex-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+codeannex-0.1.1.dist-info/entry_points.txt,sha256=xlUIEdNxk24viV-kCqMmN-eJ2ahMu7QGPnwqz7A1ofg,54
+codeannex-0.1.1.dist-info/top_level.txt,sha256=AZs8rICsPbgAe4_7pAHKgqEDw378hWwKk8jZDdgFSs4,10
+codeannex-0.1.1.dist-info/RECORD,,

codeannex-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

codeannex-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+codeannex = codeannex.__main__:main

codeannex-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tanhleno Teixeira de Sousa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

codeannex-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+codeannex