Skip to main content

A Flask-based web service to convert documents to Markdown

Project description

Markdown Converter

A Flask-based web service to convert any document/url to Markdown.

Installation

pip install markdown-converter

Usage

As a web service

Start the server:

markdown-converter serve

Options:

  • --host: Host to bind to (default: 0.0.0.0)
  • --port: Port to bind to (default: 5000)
  • --debug: Enable debug mode

API Endpoints

Convert URL to Markdown

curl -X POST -F "url=https://example.com" http://localhost:5000/convert

Convert File to Markdown

curl -X POST -F "file=@document.pdf" http://localhost:5000/convert

Development

  1. Clone the repository
  2. Install dependencies: pip install -r requirements.txt
  3. Run the development server: python -m markdown_converter.cli serve --debug

License

MIT License

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

markdown_converter-0.1.0.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

markdown_converter-0.1.0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file markdown_converter-0.1.0.tar.gz.

File metadata

  • Download URL: markdown_converter-0.1.0.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.2

File hashes

Hashes for markdown_converter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 40a708ce30abfaad40720db8e1ce0fd51be877a9802bda89ddf9fa2c02308d33
MD5 55cd2258f5ca0c498985b0b6ca6c19e4
BLAKE2b-256 6670e369f24c55035222dff043a4698b051f68a8f4491a26eb4989708e158c29

See more details on using hashes here.

File details

Details for the file markdown_converter-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for markdown_converter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0d94b2304a80c3d7f39002cc33564cd19be7839e02aaef7615b8c7572c1ddf0
MD5 e2f7e48bd667f2c17976f6a2080d4015
BLAKE2b-256 6939406256b717829f9c6b15a612ae798493ea8e1fcd7cc8b1536107462807db

See more details on using hashes here.

Supported by

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