Metadata-Version: 2.1
Name: markline
Version: 0.2.0
Summary: Convert Markup to Markdown with a transformation pipeline.
Home-page: https://github.com/hughcameron/markline
License: MIT
Author: Hugh Cameron
Author-email: hescameron+githubprojects@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
Requires-Dist: furl (>=2.1.3,<3.0.0)
Requires-Dist: httpx (>=0.23.0,<0.24.0)
Requires-Dist: pandoc (>=2.2,<3.0)
Project-URL: Repository, https://github.com/hughcameron/markline
Description-Content-Type: text/markdown

# <img src="img/markline.svg" width="200">

**Markline** converts HTML to Markdown and supports transformation methods borrowed from data engineering concepts. The goal of this project is to provide a simple API that renders HTML to Markdown for note management applications such as [Logseq](https://logseq.com).


## Getting Started

### Installation

Markline is available on PyPI:

```bash
python -m pip install markline
```

#### Dependencies

Markdown rendering is performed with [Pandoc](https://pandoc.org/) so the `pandoc` command-line tool needs to be available in your environment. You may follow [the official installation instructions](https://pandoc.org/installing.html)
which are OS-dependent, or if you are a [conda](https://www.google.com/search?q=conda+python) user, with the following command:

```bash
conda install -c conda-forge pandoc
```

Beautiful Soup supports the HTML parser included in Python's standard library, but it also supports a number of third-party Python parsers. One is the [lxml parser](http://lxml.de/) which provides a good balance between performance and accuracy. More information about the parsers can be found in the [Beautiful Soup documentation](https://www.crummy.com/software/BeautifulSoup/bs4/doc/#installing-a-parser).

 For conda users, you can install the lxml package with the following command:

```bash
conda install -c conda-forge lxml
```

