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.2.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pydelorean-1.5.2.tar.gz
  • Upload date:
  • Size: 12.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.2.tar.gz
Algorithm Hash digest
SHA256 e68d7cacf59ccda889479fd0bc05ebb685b5c1f199d68a20a482335f0f806f89
MD5 14f28e947e6afbc249d95a4f9ba4567d
BLAKE2b-256 ad084f6fdb83fd34aecdf4ad8c9d61eb719fe19b974f35539de3c4963f3d4ecb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pydelorean-1.5.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 70a77cf66509dc334d56b590593324c9b8fe487e41c53262d9b2ceb5718bd5a2
MD5 b78290da7c050e0f7f6dda822fd8cf36
BLAKE2b-256 fa365b3c90dd8357b027b816651085a61ea7d02a215305fd535ff719a736d527

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