Skip to content

0.1.0

Choose a tag to compare

View all tags
@pablotoledo pablotoledo released this 11 Jan 17:03
· 49 commits to main since this release
0.1.0
2bfe13e

Release Notes - v0.1.0

Initial release of Readium, a documentation extraction and analysis tool.

What's New

Core Features

  • Documentation extraction from local directories and Git repositories
  • Support for multiple document formats through MarkItDown integration
  • Configurable file processing with size limits and exclusion patterns
  • Debug mode for detailed processing information

File Support

  • Documentation: .md, .mdx, .rst, .txt
  • Office documents (via MarkItDown): .pdf, .docx, .xlsx, .pptx
  • Source code: Multiple programming languages supported
  • Configuration: .yml, .toml, .json, etc.

Command Line Interface

  • Basic directory/repository processing
  • Output file generation
  • Configurable options for processing control
  • Debug mode support

Python API

  • ReadConfig class for flexible configuration
  • Readium class for programmatic access
  • Integration with MarkItDown for document conversion

Installation

pip install readium

Known Issues

  • Binary files are excluded by default unless processed through MarkItDown
  • Git repository processing requires git to be installed

Dependencies

  • Python ≥ 3.10
  • Required packages: click, rich, markitdown, black, isort
Assets 2
Loading