Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alvinwan/md2py
converts markdown into a Python parse tree
https://github.com/alvinwan/md2py
Last synced: 17 days ago
JSON representation
converts markdown into a Python parse tree
- Host: GitHub
- URL: https://github.com/alvinwan/md2py
- Owner: alvinwan
- License: apache-2.0
- Created: 2016-01-07T18:42:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-02T04:57:58.000Z (over 8 years ago)
- Last Synced: 2024-10-06T07:18:29.299Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 57
- Watchers: 1
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown2Python (md2py)
md2py converts markdown into a Python parse tree. This allows you to
navigate a markdown file as a document structure.
See [tex2py](https://github.com/alvinwan/tex2py) for a LaTeX parse tree.
## Usage
Markdown2Python offers only one function `md2py`, which generates a Python
object from markdown text. This object is a navigable, "Tree of Contents"
abstraction for the markdown file.
Take, for example, the following markdown file.
**chikin.md**
```
# Chikin Tales
## Chapter 1 : Chikin Fly
Chickens don't fly. They do only the following:
- waddle
- plop
### Waddling
## Chapter 2 : Chikin Scream
### Plopping
Plopping involves three steps:
1. squawk
2. plop
3. repeat, unless ordered to squat
### I Scream
```
Akin to a navigation bar, the `TreeOfContents` object allows you to expand a
markdown file one level at a time. Running `md2py` on the above markdown file
will generate a tree, abstracting the below structure.
```
Chikin Tales
/ \
Chapter 1 Chapter 2
/ / \
Waddling Plopping I Scream
```
At the global level, we can access the title.
```
>>> toc = md2py(markdown)
>>> toc.h1
Chikin Tales
>>> str(toc.h1)
'Chikin Tales'
```
Notice that at this level, there are no `h2`s.
```
>>> list(toc.h2s)
[]
```
The main `h1` has two `h2`s beneath it. We can access both.
```
>>> list(toc.h1.h2s)
[Chapter 1 : Chikin Fly, Chapter 2 : Chikin Scream]
>>> toc.h1.h2
Chapter 1 : Chikin Fly
```
In total, there are 3 `h3`s in this document. However, only 1 `h3` is
actually nested within 'Chapter 1 : Chikin Fly' (accessible via `toc.h1.h2`).
As a result, `toc.h1.h2.h3s` will only show one `h3`s.
```
>>> list(toc.h1.h2.h3s)
['Waddling']
```
The `TreeOfContents` class also has a few more conveniences defined. Among them
is support for indexing. To access the `i`th child of an `` - instead of `.branches[i]` - use `[i]`.
See below for example usage.
```
>>> toc.h1.branches[0] == toc.h1[0] == toc.h1.h2
True
>>> list(toc.h1.h2s)[1] == toc.h1[1]
True
>>> toc.h1[1]
Chapter 2 : Chikin Scream
>>> list(toc.h1[1].h3s)
[Plopping, I Scream]
>>> list(map(str, toc.h1[1].h3s))
['Plopping', 'I Scream']
```
## Installation
Install via pip.
```
pip install md2py
```
## Additional Notes
- Behind the scenes, the md2py uses `BeautifulSoup`. All md2py objects have a
`source` attribute containing a BeautifulSoup object.