Skip to main content

Convert AI chat conversations to structured Markdown

Project description

aichat2md

Convert AI chat conversations to structured Markdown documents.

Features

  • 🌐 Extract from URLs - ChatGPT share links (with JS rendering via Playwright)
  • 📄 Extract from webarchive - Safari .webarchive files (offline mode)
  • 🤖 Multiple AI backends - DeepSeek, OpenAI, Groq, or any OpenAI-compatible API
  • 🌍 Bilingual support - English/Chinese prompts
  • 📝 Clean output - Knowledge-focused Markdown, not chat logs
  • Simple CLI - pip-installable, one-time setup

Quick Start

# Install
pip install aichat2md

# Configure (one-time setup)
aichat2md --setup

# Convert a ChatGPT share URL
aichat2md https://chatgpt.com/share/xxx

# Convert a webarchive file
aichat2md ~/Downloads/chat.webarchive

Supported AI Backends

  • DeepSeek (default) - Cost-effective, Chinese service
  • OpenAI - GPT-4o-mini, GPT-4
  • Groq - Fast inference with Llama models
  • Custom - Any OpenAI-compatible API

Installation

Prerequisites

  • Python 3.8 or higher
  • Playwright (automatically installed, but requires browser setup)

Install from PyPI

pip install aichat2md

Install Playwright browsers

playwright install chromium

First-time Setup

aichat2md --setup

You'll be prompted to:

  1. Select your AI provider (DeepSeek, OpenAI, Groq, or custom)
  2. Enter your API key
  3. Choose prompt language (English or Chinese)
  4. Set output directory (default: ~/Downloads)

Usage

Basic Usage

# Convert from URL (uses configured output directory)
aichat2md https://chatgpt.com/share/xxx

# Convert from webarchive (outputs to same directory as input)
aichat2md ~/Downloads/chat.webarchive

Override Language

# Use Chinese prompts (even if English is configured)
aichat2md <url> --lang zh

# Use English prompts
aichat2md <url> --lang en

Custom Output Path

# Specify output file
aichat2md <url> -o ~/Documents/my-notes.md
aichat2md <url> --output ~/Documents/my-notes.md

Override Model

# Use a different model than configured
aichat2md <url> --model gpt-4o
aichat2md <url> --model deepseek-chat

Version Info

aichat2md --version

Configuration

Configuration is stored in ~/.config/aichat2md/config.json (cross-platform).

Example Config

{
  "api_key": "sk-your-api-key",
  "api_base_url": "https://api.deepseek.com",
  "model": "deepseek-chat",
  "language": "en",
  "output_dir": "/Users/you/Downloads",
  "max_tokens": 4000,
  "temperature": 0.7
}

Reconfigure

aichat2md --setup

Output Format

The tool converts chat conversations into structured Markdown with:

  • Front matter - Tags, date, source
  • Summary - 2-3 sentence overview
  • Key topics - Bullet point list
  • Knowledge sections - Reorganized content with logical headings
  • Code examples - Extracted code blocks with comments

Example Output

---
tags: [Python, API, Web]
date: 2026-02-02
source: https://chatgpt.com/share/xxx
---

# Building REST APIs with FastAPI

## Summary
This document covers building production-ready REST APIs using FastAPI...

## Key Topics
- API design patterns
- Request validation
- Error handling

## API Design Principles
...

## Code Examples
\```python
from fastapi import FastAPI
app = FastAPI()
...
\```

How It Works

  1. Extract - Playwright (URLs) or plistlib (webarchive) extracts raw text
  2. Structurize - AI API reorganizes into knowledge document
  3. Save - Auto-generated filename or specified path

Why Two-Stage Processing?

  • Stage 1 (Extract) - No AI tokens used, just HTML parsing
  • Stage 2 (Structurize) - AI organizes content efficiently

This saves costs and allows local caching of extracted content.

Development

Local Installation

# Clone repository
git clone https://github.com/yourusername/aichat2md.git
cd aichat2md

# Install in editable mode
pip install -e .

# Install Playwright
playwright install chromium

Run Tests

pip install pytest
pytest tests/

Build Package

pip install build
python -m build

Troubleshooting

"Configuration file not found"

Run aichat2md --setup to create configuration.

"API authentication failed"

Check your API key in ~/.config/aichat2md/config.json.

Playwright errors

Install browsers: playwright install chromium

Empty output

The conversation might be too short or the AI response failed. Check error messages.

Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new features
  4. Submit a pull request

License

MIT License - see LICENSE file.

Links

Acknowledgments

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

aichat2md-1.0.1.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

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

aichat2md-1.0.1-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file aichat2md-1.0.1.tar.gz.

File metadata

  • Download URL: aichat2md-1.0.1.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for aichat2md-1.0.1.tar.gz
Algorithm Hash digest
SHA256 138df4285aaea75819f6c61a36bc7be3b1747f76491e2d0c02e68cc64b195749
MD5 b0376b2654986d45af25d2cd53b5f7eb
BLAKE2b-256 e1ad90b4efe03297ff5ddcf7ceec6a27a408fb48a6e2cf3f7ee3b6a1fffce10a

See more details on using hashes here.

File details

Details for the file aichat2md-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: aichat2md-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for aichat2md-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6ffae6b78b563df2e9fd73dc49a95b3d4b16fc97e688094cc9584bc703f90100
MD5 02b1085c15edc42968eb04add9b136c1
BLAKE2b-256 8e6d17fd85aaf2e2fbf4d9a9289175b657834982f64a90b7682a08d5d4620b2b

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