Skip to main content

Overview

This project implements a Python parser for Emacs Org-Mode files providing nice semantic nodes in a hierarchical document tree. It's based on this Tree-Sitter grammar.

org-parser was created as an alternative to the wonderful, but admittedly incomplete and unmaintained orgparse. The main improvements on top of orgparse are:

  • Almost complete feature set, including markup, blocks, tables and more niche constructs such as Babel calls.
  • Fully mutable tree for easy edits that preserves original document whitespace & formatting.
  • Better document error handling and reporting, useful for validation.

See the documentation here.

Installation

pip install org-parser

Features

  • Semantic nodes with all the expected attributes
>>> from org_parser import loads
>>> doc = loads('''
... #+TITLE: Document
... #+AUTHOR: Idorobots
... :PROPERTIES:
... :name: value
... :END:
... An example document.
... * Heading 1
... ** Heading 2               :tag:
... *** Heading 3
... ''')
>>> doc.title
RichText('Document')
>>> doc.body
[BlankLine(), Paragraph(body=RichText('An example document.\n'))]
>>> doc.body_text
'\nAn example document.\n'
>>> doc.properties["name"]
RichText('value')
>>> len(doc.all_headings)
3
>>> doc.all_headings[1].tags
['tag']
  • Structured traversal
>>> from org_parser import loads
>>> doc = loads('''
... * Heading 1
... ** Heading 2
... *** Heading 3
... ''')
>>> doc.children[0].title
RichText('Heading 1')
>>> doc.children[0].children[0].title
RichText('Heading 2')
>>> doc.children[0].children[0].parent.title == "Heading 1"
True
>>> doc.children[0].children[0].siblings
[]
  • Original source whitespace and formatting preserved by default
>>> from org_parser import loads
>>> doc = loads('''
... #+TITLE: Original formatting
... * Heading 1
...   Indented section
...      remains indented 
...    in-tree.  
... ''')
>>> print(str(doc.children[0]))
* Heading 1
  Indented section
     remains indented 
   in-tree.  

>>> print(doc.render())

#+TITLE: Original formatting
* Heading 1
  Indented section
     remains indented 
   in-tree.  
  • Fully mutable tree allowing dynamic edits
>>> from org_parser import loads
>>> from org_parser.element import Paragraph
>>> doc = loads('''
... #+TITLE: Document title
... * Heading 1
...   Body text.
... ''')
>>> doc.title
RichText('Document title')
>>> doc.title.text = "Another title"
>>> doc[0].body = [Paragraph.from_source("New *and* improved!")]
>>> doc[0].title.text = "Improved heading"
>>> print(doc.render())
#+TITLE: Another title

* Improved heading
New *and* improved!
  • Org Table support
>>> from org_parser import loads
>>> doc = loads('''
... |Value|Double|
... |1| |
... |2| |
... |3| |
... ''')
>>> for r in doc.body[1].rows[1:]:
...   r[1].text = str(2 * int(r[0].text))
...   
>>> print(doc.render())

| Value | Double |
| 1     | 2      |
| 2     | 4      |
| 3     | 6      |
  • Rich Text support
>>> from org_parser.text import RichText
>>> text = RichText.from_source("Supports *org-mode* /markup/ and inline_{objects}: <2026-03-29>")
>>> text
RichText('Supports *org-mode* /markup/ and inline_{objects}: <2026-03-29>')
>>> text.parts
[PlainText(text='Supports '), Bold(body=[PlainText(text='org-mode')]), PlainText(text=' '), Italic(body=[PlainText(text='markup')]), PlainText(text=' and inline'), Subscript(body=[PlainText(text='objects')], form='{}'), PlainText(text=': '), Timestamp(is_active=True, start_year=2026, start_month=3, start_day=29), PlainText(text='')]
  • Error recovery
>>> from org_parser import loads
>>> doc = loads('''
... * Heading
... SCHEDULED: yesterday
... ''')
>>> doc[0].scheduled is None
True
>>> doc.errors
[ParseError(start_point=Point(row=2, column=0), end_point=Point(row=2, column=20), text='SCHEDULED: yesterday')]

Metadata

Release files for org-parser 0.28.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for org-parser 0.28.0
File Size Uploaded
org_parser-0.28.0.tar.gz 75.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for org-parser 0.28.0
File Interpreter ABI Platform
org_parser-0.28.0-py3-none-any.whl Python 3 none any Details

Total release size: 167.2 kB

Release files / org_parser-0.28.0.tar.gz

Download URL org_parser-0.28.0.tar.gz
Size 75.7 kB
Tags Source
SHA-256 checksum
How to use checksums
7e027567aed98d71ec5f16ab7dbc4bf8873d924529dc57b9318477244a42375d
BLAKE2b-256 checksum
How to use checksums
e018b3379a67bde8899f153aac788f8ecf9f6bb0b094d87a193a36bbc87504fc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / org_parser-0.28.0-py3-none-any.whl

Download URL org_parser-0.28.0-py3-none-any.whl
Size 91.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4d9387053be1de82f4b9fd961a1cc972e29d68b142e9906bce500975b05dd194
BLAKE2b-256 checksum
How to use checksums
0a75680bac2757f982111b1d07f9d401655e0b3a06e0fd6b80ba3c7516c0d219
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

This release

0.28.0 This release

2 release files

0.27.0

2 release files

0.26.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page