A library to analyze markdown files
Project description
mrkdwn_analysis
mrkdwn_analysis
is a Python library designed to analyze Markdown files. With its powerful parsing capabilities, it can extract and categorize various elements within a Markdown document, including headers, sections, links, images, blockquotes, code blocks, and lists. This makes it a valuable tool for anyone looking to parse Markdown content for data analysis, content generation, or for building other tools that utilize Markdown.
Features
- Extract and categorize various elements of a Markdown file.
- Handle both inline and reference-style links and images.
- Recognize different types of headers and sections.
- Identify and extract code blocks, even nested ones.
- Handle both ordered and unordered lists, nested or otherwise.
- A simple API that makes parsing Markdown documents a breeze.
Usage
Using mrkdwn_analysis
is simple. Just import the MarkdownAnalyzer
class, create an instance with your Markdown file, and you're good to go!
from mrkdwn_analysis import MarkdownAnalyzer
analyzer = MarkdownAnalyzer("path/to/your/markdown.md")
headers = analyzer.identify_headers()
sections = analyzer.identify_sections()
...
Installation
You can install mrkdwn_analysis
from PyPI:
pip install mrkdwn_analysis
We hope mrkdwn_analysis
helps you with all your Markdown analyzing needs!
Contributions
Contributions are always welcome! If you have a feature request, bug report, or just want to improve the code, feel free to create a pull request or open an issue.
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
Built Distribution
Hashes for markdown_analysis-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82e8560d0951fa9a712896a6b8b284d820462889291963642fa98a549ef4d10b |
|
MD5 | 4d4b89d5ee36104de409b79a8588a59b |
|
BLAKE2b-256 | a90f1068101bf8e0c756821dd62bcd6389826d6c65056fd312f25dd342e7804f |