| Name | darkdown JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | https://github.com/phx/darkdown |
| Summary | A Python3 http.server wrapper that supports SSL, basic auth, markdown rendering, and styling support for markdown files and directory listings |
| upload_time | 2024-10-20 05:02:46 |
| maintainer | None |
| docs_url | None |
| author | phx |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# darkdown
A Python 3 `http.server` wrapper that supports ssl, basic auth, markdown rendering, and styling support for directory listings and markdown files.
## Installation
```sh
python3 -m pip install darkdown
```
## Manual Installation
```sh
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)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/phx/darkdown",
"name": "darkdown",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "phx",
"author_email": "emai@example.com",
"download_url": "https://files.pythonhosted.org/packages/bd/c8/bad716f7ba8743fee5bc4bd3282831c2db0ae5b15246a08833de77595267/darkdown-1.0.4.tar.gz",
"platform": null,
"description": "\n\n# darkdown\n\nA Python 3 `http.server` wrapper that supports ssl, basic auth, markdown rendering, and styling support for directory listings and markdown files.\n\n## Installation\n\n```sh\npython3 -m pip install darkdown\n```\n\n## Manual Installation\n\n```sh\ngit clone https://github.com/phx/darkdown\ncd darkdown\npython3 -m pip install -r requirements.txt\n```\n\n## Usage\n\n```\nusage: darkdown [-h] [-p PORT] [-b ADDRESS] [--directory DIRECTORY] [-u USERNAME] [-P PASSWORD] [-c CERTFILE] [-k KEYFILE]\n\nSecure Markdown HTTP server with GitHub-style rendering, authentication, and HTTPS support.\n\noptions:\n -h, --help show this help message and exit\n -p PORT, --port PORT Specify alternate port [default: 8000]\n -b ADDRESS, --bind ADDRESS\n Specify alternate bind address [default: all interfaces]\n --directory DIRECTORY\n Specify alternate directory [default: current directory]\n -u USERNAME, --user USERNAME\n Set a username for basic authentication\n -P PASSWORD, --password PASSWORD\n Set a password for basic authentication\n -c CERTFILE, --cert CERTFILE\n Path to the SSL certificate file (for HTTPS)\n -k KEYFILE, --key KEYFILE\n Path to the SSL key file (for HTTPS)\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python3 http.server wrapper that supports SSL, basic auth, markdown rendering, and styling support for markdown files and directory listings",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/phx/darkdown"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "306f4c64b3932946a9ef606ef2d57cc0475269b70efff29f00c5a761be7a89d1",
"md5": "4c53560e3ffd63fb6a8a4ef51b171827",
"sha256": "159a51b0c7fb3a889d43f83c44b224975d4cc06d59ee3980b25171d2fdd1a95d"
},
"downloads": -1,
"filename": "darkdown-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c53560e3ffd63fb6a8a4ef51b171827",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5811,
"upload_time": "2024-10-20T05:02:45",
"upload_time_iso_8601": "2024-10-20T05:02:45.422736Z",
"url": "https://files.pythonhosted.org/packages/30/6f/4c64b3932946a9ef606ef2d57cc0475269b70efff29f00c5a761be7a89d1/darkdown-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bdc8bad716f7ba8743fee5bc4bd3282831c2db0ae5b15246a08833de77595267",
"md5": "bc5462f728edc8b773cf8d5a7428681c",
"sha256": "b46dfa24294438027d3a3009fb787fda40bf5c9157f8cda132740f13be757f03"
},
"downloads": -1,
"filename": "darkdown-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "bc5462f728edc8b773cf8d5a7428681c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5498,
"upload_time": "2024-10-20T05:02:46",
"upload_time_iso_8601": "2024-10-20T05:02:46.297083Z",
"url": "https://files.pythonhosted.org/packages/bd/c8/bad716f7ba8743fee5bc4bd3282831c2db0ae5b15246a08833de77595267/darkdown-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 05:02:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phx",
"github_project": "darkdown",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "darkdown"
}
