Skip to main content

A package to convert between markup documents and a forest data structure for efficient processing.

Project description

pydelorean

delorean

A library to convert markup documents into tree data structures and vice versa. There is greater functionality available to modify, prune, add and delete parts of documents when there are in the MarkdownTree structure.

The full list of features can be found in FEATURES.md or in the documentation.

Install

Install via pip

   pip install pydelorean

You can find the library page here here <nil>__

Quick Usage Guide

The library can be used to convert markdown documents into forest data strucutre. Using just the treeify command on the following text

# Chikin Tales
Once there was a chikin.
## Chapter 1 : Chikin Fly
Chickens don't fly. They do only the following:
- waddle
- plop 
### Waddling
A waddle is what these birds do.
## Chapter 2 : Chikin Scream
### Plopping
Plopping involves three steps:
1. squawk
2. plop
3. repeat, unless ordered to squat
   from pydelorean import treeify
   tree = treeify(text)
   print(tree)
                   Chikin Tales
                  /     \       \
                 /       \       \
           (Once th..)    |       \
                          |        \
                      Chapter 1     \
                      /     |     Chapter 2
                     /      |         |
           (Chickens do..)  |       Plopping
                            |         |
                         Waddling   (Plopping...)
                            |
                        (A waddle...)

For a usage guide, access the samples/ directory or check out the documentation page here - nil

Features

Some of the features of this library are:

  • forest data structure for Markdown, reStructuredText, AsciiDoc, JSON, YAML and XML.
  • 'cleaning' of documents to remove unwanted elements.
  • document manipulation using the tree data structure.

Refer to the FEATURES.md file for more information or you can visit the documentation page here - nil

License

This project is licensed under the Apache 2.0 License. A copy of the license can be found in the LICENSE file.

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

pydelorean-1.5.3.tar.gz (64.2 kB view details)

Uploaded Source

Built Distribution

pydelorean-1.5.3-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file pydelorean-1.5.3.tar.gz.

File metadata

  • Download URL: pydelorean-1.5.3.tar.gz
  • Upload date:
  • Size: 64.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for pydelorean-1.5.3.tar.gz
Algorithm Hash digest
SHA256 142484a99ffe5c5c121f58c1e06f968158f3aabf39a341d4510a99b82510a810
MD5 6e5d43e788676f5d614daa932580b7ab
BLAKE2b-256 058424a858fc6386b58767d6027a07e4b6afc392d307540c95830da215954cdd

See more details on using hashes here.

File details

Details for the file pydelorean-1.5.3-py3-none-any.whl.

File metadata

  • Download URL: pydelorean-1.5.3-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for pydelorean-1.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 abf3ab92ac78a86f8e8ae35baf892221b3adf5ffa1bc504a1ac505db09f10e33
MD5 6cee0209217c255c993b5cf2ffce7e30
BLAKE2b-256 8a74fe8357f1b65db7ffd0eba912af4a37983d582def7eb42b243bccdeab67ee

See more details on using hashes here.

Supported by

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