# md-server
HTTP API server for converting files, documents, web pages, and multimedia content to markdown.
## Installation
```bash
uvx md-server
```
## Usage
```bash
# Start server (default: localhost:8080)
uvx md-server
# Listen on all interfaces (for Docker/remote access)
uvx md-server --host 0.0.0.0
# Start on custom port
uvx md-server --port 9000
# Convert file
curl -X POST http://localhost:8080/convert -F "file=@document.pdf"
# Convert YouTube video
curl -X POST http://localhost:8080/convert/url -d '{"url": "https://youtube.com/watch?v=..."}'
# Convert web page
curl -X POST http://localhost:8080/convert/url -d '{"url": "https://example.com/article"}'
# Health check
curl http://localhost:8080/healthz
```
## Endpoints
- `GET /healthz` - Health check
- `POST /convert` - Convert uploaded file to markdown
- `POST /convert/url` - Convert content from URL to markdown
## Development
```bash
# Clone repository
git clone https://github.com/peteretelej/md-server.git
cd md-server
# Create virtual environment and install dependencies
uv sync
# Run development server (localhost:8080)
uv run python -m md_server
# or
uv run md-server
# Run on custom port
uv run md-server --port 9000
# Run tests (when available)
uv run pytest
# Add new dependencies
uv add package-name
# Add dev dependencies
uv add --dev pytest ruff mypy
```
## TODO
- [x] Health endpoint for health check
- [ ] API endpoints for file upload & conversion
- [ ] Determine response format
- [ ] Support for URL input
- [ ] Format support validation: PDF, ppt, docx, excel etc
- [ ] tests + 90%+ coverage
- [ ] Dockerfile & run guidance
- [ ] CI/CD for for repo + PyPI publishing
Raw data
{
"_id": null,
"home_page": null,
"name": "md-server",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Peter Etelej <peter@etelej.com>",
"keywords": "markdown, document-conversion, api, server, fastapi, pdf, docx",
"author": null,
"author_email": "Peter Etelej <peter@etelej.com>",
"download_url": "https://files.pythonhosted.org/packages/cb/45/07cdc51e430ad6e214041f3a5edfb505f916de00eda79ae5c0da184070d7/md_server-0.0.1.tar.gz",
"platform": null,
"description": "# md-server\n\nHTTP API server for converting files, documents, web pages, and multimedia content to markdown.\n\n## Installation\n\n```bash\nuvx md-server\n```\n\n## Usage\n\n```bash\n# Start server (default: localhost:8080)\nuvx md-server\n\n# Listen on all interfaces (for Docker/remote access)\nuvx md-server --host 0.0.0.0\n\n# Start on custom port\nuvx md-server --port 9000\n\n# Convert file\ncurl -X POST http://localhost:8080/convert -F \"file=@document.pdf\"\n\n# Convert YouTube video\ncurl -X POST http://localhost:8080/convert/url -d '{\"url\": \"https://youtube.com/watch?v=...\"}'\n\n# Convert web page\ncurl -X POST http://localhost:8080/convert/url -d '{\"url\": \"https://example.com/article\"}'\n\n# Health check\ncurl http://localhost:8080/healthz\n```\n\n## Endpoints\n\n- `GET /healthz` - Health check\n- `POST /convert` - Convert uploaded file to markdown\n- `POST /convert/url` - Convert content from URL to markdown\n\n## Development\n\n```bash\n# Clone repository\ngit clone https://github.com/peteretelej/md-server.git\ncd md-server\n\n# Create virtual environment and install dependencies\nuv sync\n\n# Run development server (localhost:8080)\nuv run python -m md_server\n# or\nuv run md-server\n\n# Run on custom port\nuv run md-server --port 9000\n\n# Run tests (when available)\nuv run pytest\n\n# Add new dependencies\nuv add package-name\n\n# Add dev dependencies\nuv add --dev pytest ruff mypy\n```\n\n## TODO\n\n- [x] Health endpoint for health check\n- [ ] API endpoints for file upload & conversion\n- [ ] Determine response format\n- [ ] Support for URL input\n- [ ] Format support validation: PDF, ppt, docx, excel etc\n- [ ] tests + 90%+ coverage\n- [ ] Dockerfile & run guidance\n- [ ] CI/CD for for repo + PyPI publishing\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "HTTP API server for document-to-markdown conversion",
"version": "0.0.1",
"project_urls": {
"Documentation": "https://github.com/peteretelej/md-server#readme",
"Homepage": "https://github.com/peteretelej/md-server",
"Issues": "https://github.com/peteretelej/md-server/issues",
"Repository": "https://github.com/peteretelej/md-server.git"
},
"split_keywords": [
"markdown",
" document-conversion",
" api",
" server",
" fastapi",
" pdf",
" docx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "98e032ce83ff028d4bb9421519235d98a659cfc7b9fbaca653f194c38aadc30b",
"md5": "2c5aecd96c60d8ad4ed8398c641a493c",
"sha256": "5a868c60169bbd737b4ee82cf4b48a78cacd8bc3dbda17d96f4ccac99a7f2dc3"
},
"downloads": -1,
"filename": "md_server-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c5aecd96c60d8ad4ed8398c641a493c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3262,
"upload_time": "2025-08-02T19:59:03",
"upload_time_iso_8601": "2025-08-02T19:59:03.524252Z",
"url": "https://files.pythonhosted.org/packages/98/e0/32ce83ff028d4bb9421519235d98a659cfc7b9fbaca653f194c38aadc30b/md_server-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "cb4507cdc51e430ad6e214041f3a5edfb505f916de00eda79ae5c0da184070d7",
"md5": "c44f7a2e3199c6dc45c8d130791ea562",
"sha256": "ff5b3c2311b365a6ba28d9e99961298d769a370ed6e5ed2c2dc6328c9908370b"
},
"downloads": -1,
"filename": "md_server-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c44f7a2e3199c6dc45c8d130791ea562",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 2897,
"upload_time": "2025-08-02T19:59:04",
"upload_time_iso_8601": "2025-08-02T19:59:04.583674Z",
"url": "https://files.pythonhosted.org/packages/cb/45/07cdc51e430ad6e214041f3a5edfb505f916de00eda79ae5c0da184070d7/md_server-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-02 19:59:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "peteretelej",
"github_project": "md-server#readme",
"github_not_found": true,
"lcname": "md-server"
}
JSON
