Skip to main content

A Python3 http.server wrapper that supports SSL, basic auth, markdown rendering, and styling support for markdown files and directory listings

Project description

darkdown

darkdown

A Python 3 http.server wrapper that supports ssl, basic auth, markdown rendering, and styling support for directory listings and markdown files.

Installation

python3 -m pip install darkdown

Manual Installation

git clone https://github.com/phx/darkdown
cd darkdown
python3 -m pip install -r requirements.txt

Usage

usage: darkdown [-h] [-p PORT] [-b ADDRESS] [--directory DIRECTORY] [-u USERNAME] [-P PASSWORD] [-c CERTFILE] [-k KEYFILE]

Secure Markdown HTTP server with GitHub-style rendering, authentication, and HTTPS support.

options:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  Specify alternate port [default: 8000]
  -b ADDRESS, --bind ADDRESS
                        Specify alternate bind address [default: all interfaces]
  --directory DIRECTORY
                        Specify alternate directory [default: current directory]
  -u USERNAME, --user USERNAME
                        Set a username for basic authentication
  -P PASSWORD, --password PASSWORD
                        Set a password for basic authentication
  -c CERTFILE, --cert CERTFILE
                        Path to the SSL certificate file (for HTTPS)
  -k KEYFILE, --key KEYFILE
                        Path to the SSL key file (for HTTPS)

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

darkdown-1.0.3.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

darkdown-1.0.3-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file darkdown-1.0.3.tar.gz.

File metadata

  • Download URL: darkdown-1.0.3.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for darkdown-1.0.3.tar.gz
Algorithm Hash digest
SHA256 cdba9cd5c083b4b6c44bc8fea28927c8bd0a58a884ced0a0f93b30350c483200
MD5 0dd507abf8651782322c92346459b7a0
BLAKE2b-256 bf9aad3c5ac0c5df35ea9586d2daa98315ff89b311c7d9158bd80f243d9db267

See more details on using hashes here.

File details

Details for the file darkdown-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: darkdown-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for darkdown-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 07bb2a835f6aaa291d7334ca42853e5e4da65045719f222f85a4777dcbcbc673
MD5 38044b9cf97674c7aefae159747c5add
BLAKE2b-256 43c2840dcf37c742d37a916262d15e238f63d2c127b4ce6d41af03e225d730b8

See more details on using hashes here.

Supported by

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