Skip to main content

A Flask-based web service to convert any document/url 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.1.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.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: markdown_converter-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 f19974bba776f11f14e997c5b088425f89706e74e23c94670b115d4c88797f49
MD5 7105e5dcba82f5de17b1392713ecc708
BLAKE2b-256 c7ad40896cb82f6925fb614f96f069be30e666c17b7b6359f0cc394ae0648861

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_converter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2343a2d03f3a4b2c1e80fd2857a9b7a3805a7511bfd68d430063329db47ff57f
MD5 0e5053acce0659fb50fe1e4feee6dfae
BLAKE2b-256 cdbe4801fa98ee4a0b3c49a94a3b73880bb0f9ec13d314e36702c13f83b309a8

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