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.4.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: darkdown-1.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 b46dfa24294438027d3a3009fb787fda40bf5c9157f8cda132740f13be757f03
MD5 bc5462f728edc8b773cf8d5a7428681c
BLAKE2b-256 bdc8bad716f7ba8743fee5bc4bd3282831c2db0ae5b15246a08833de77595267

See more details on using hashes here.

File details

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

File metadata

  • Download URL: darkdown-1.0.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 159a51b0c7fb3a889d43f83c44b224975d4cc06d59ee3980b25171d2fdd1a95d
MD5 4c53560e3ffd63fb6a8a4ef51b171827
BLAKE2b-256 306f4c64b3932946a9ef606ef2d57cc0475269b70efff29f00c5a761be7a89d1

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