Skip to main content

AlcheMark AI - PDF to Markdown conversion with rich metadata and element analysis

Project description

AlcheMark AI.

AlcheMark AI Logo

AlcheMark is a lightweight PDF to Markdown, alchemical-inspired toolkit that transmutes PDF documents into structured Markdown pages—complete with rich metadata and markdown element annotations—empowering you to uncover insights page by page.

Installation

# Install from PyPI
pip install alchemark-ai

# Or install from source
git clone https://github.com/matthsena/AlcheMark-ai.git
cd AlcheMark-ai
pip install -e .

Usage

from alchemark_ai import pdf2md

# Convert PDF to markdown
results = pdf2md("path/to/document.pdf", process_images=True)

# Each result is a FormattedResult object with the structure:
# {
#   "metadata": {
#     "file_path": str,       # Path to the PDF file
#     "page": int,            # Page number
#     "page_count": int,      # Total number of pages
#     "text_length": int,     # Length of the extracted text
#     "processed_timestamp": float  # Processing timestamp
#   },
#   "elements": {
#     "tables": List[Table],  # Tables extracted from the page
#     "images": List[Image],  # Images extracted from the page
#     "titles": List[str],    # Titles/headers detected
#     "lists": List[str],     # List items detected
#     "links": List[Link]     # Links with text and URL
#   },
#   "text": str,              # Markdown text content
#   "tokens": int,            # Number of tokens in the text
#   "language": str           # Detected language
# }

# Access the markdown text of the first page
markdown_text = results[0].text

# Get metadata for the first page
page_number = results[0].metadata.page
total_pages = results[0].metadata.page_count

# Check elements detected in the page
tables_count = len(results[0].elements.tables)
images_count = len(results[0].elements.images)

Overview

AlcheMark AI provides a seamless solution for converting PDF documents into well-structured Markdown format. The tool not only extracts the text content but also analyzes and catalogs various elements like tables, images, headings, lists, and links while tracking token counts for LLM compatibility.

Key Features

  • PDF to Markdown Conversion: Transform PDF documents into clean, organized Markdown
  • Rich Metadata Extraction: Preserve document metadata including title, author, creation date
  • Element Analysis: Automatic detection and counting of markdown elements (headings, lists, links)
  • Table & Image Support: Extract and format tables and images from PDFs
  • Token Counting: Built-in token counting using tiktoken for LLM integration
  • Structured Output: Get page-by-page results with detailed metadata

Extracted Data Fields

Field Type Description
metadata.file_path str Path to the original PDF file
metadata.page int Current page number
metadata.page_count int Total number of pages in the document
metadata.text_length int Character count of the extracted text
metadata.processed_timestamp float Unix timestamp when the page was processed
elements.tables List[Table] Tables extracted from the page with their structure preserved
elements.images List[Image] Images extracted from the page with their metadata
elements.titles List[str] Headings and titles detected in the page
elements.lists List[str] List items (ordered and unordered) found in the page
elements.links List[Link] Hyperlinks with their display text and target URLs
text str The complete markdown text content of the page
tokens int Token count for the page (useful for LLM context planning)
language str Detected language of the page content

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alchemark_ai-0.1.5.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alchemark_ai-0.1.5-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file alchemark_ai-0.1.5.tar.gz.

File metadata

  • Download URL: alchemark_ai-0.1.5.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for alchemark_ai-0.1.5.tar.gz
Algorithm Hash digest
SHA256 8a68d7949dcf4eec0e8b0c0c07cb6bc36570bdba2923e29baee725aaa56b6328
MD5 5e5747e196be8fefa0296f2604cf99c1
BLAKE2b-256 543ef6c38c8e71005bc2b5b193b262d2ec44d9900524b3a7cda7454fcdaa408a

See more details on using hashes here.

File details

Details for the file alchemark_ai-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: alchemark_ai-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for alchemark_ai-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 656b2b5e46e34d2bdd8e272bb183dbe53ddb9c0708e60fc4153a38da74988199
MD5 075564e16b9a3ec7df0ba8dbb3efd63a
BLAKE2b-256 4e87dd3c788e84f2ff1c383631fb833021d2cc93e41d1d8c3f55a040c404cbd3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page