Welcome to pyorg’s documentation!

pyorg is a Python library for working with Org mode files and interacting with Org mode through Emacs itself.

This project, and especially the documentation, are a work in progress.

Contents:

• Installation
  • Emacs dependencies
  • Installing the package
• Quickstart
  • Getting the data from Emacs to Python
  • Explore the AST structure
• Org file structure
  • Nodes
  • Outline structure
  • Additional specialized node types
• Reading in Org file data
  • Reading from JSON export
  • Parsing Org files directly
• Interfacing directly with Org mode
  • High-level interface to Org mode
  • Communicating with Emacs
• Converting org file data to other formats
  • Plain text
  • HTML
  • JSON
  • Creating your own converters
• The agenda
• API
  • pyorg package

Indices and tables

• Index
• Module Index
• Search Page