## ReadEm: HTTP server for markdown files
Useful for:
- Previewing markdown files at ease, for your repository or anything.
- Markdown files on current directory is shown on navbar.
## Installation
```bash
$ pip3 install ReadEm
```
## Run
```bash
$ python3 -m ReadEm.serve -h
usage: serve.py [-h] [--bind ADDRESS] [port]
positional arguments:
port Specify alternate port [default: 8000]
optional arguments:
-h, --help show this help message and exit
--bind ADDRESS, -b ADDRESS
Specify alternate bind address [default: 127.0.0.1]
$ python3 -m ReadEm.serve
Listening on http://127.0.0.1:8000
Press CTRL+c to stop
127.0.0.1 - - [22/Dec/2017 14:24:40] "GET / HTTP/1.1" 200 -
127.0.0.1 - - [22/Dec/2017 14:45:17] "GET /README.md HTTP/1.1" 200 -
127.0.0.1 - - [08/Jun/2018 01:40:21] "GET /README.md HTTP/1.1" 200 -
```
Then open [127.0.0.1:8000](http://127.0.0.1:8000) on your browser.
## Credit
- [GitHub Markdown CSS](https://github.com/sindresorhus/github-markdown-css)
- [Python Markdown](https://python-markdown.github.io/)
Raw data
{
"_id": null,
"home_page": "https://github.com/jockerz/ReadEm",
"name": "ReadEm",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "readme markdown documentation",
"author": "jockerz",
"author_email": "jockerz@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/3d/44/e4b6a83194a761dd1b766c0265ebe4b03ca4393b4073dbc80bb3037546a6/ReadEm-1.0.2.tar.gz",
"platform": null,
"description": "## ReadEm: HTTP server for markdown files\n\nUseful for:\n\n- Previewing markdown files at ease, for your repository or anything.\n- Markdown files on current directory is shown on navbar.\n\n\n## Installation\n\n```bash\n$ pip3 install ReadEm\n```\n\n## Run\n\n```bash\n$ python3 -m ReadEm.serve -h\nusage: serve.py [-h] [--bind ADDRESS] [port]\n\npositional arguments:\n port Specify alternate port [default: 8000]\n\noptional arguments:\n -h, --help show this help message and exit\n --bind ADDRESS, -b ADDRESS\n Specify alternate bind address [default: 127.0.0.1]\n\n$ python3 -m ReadEm.serve\nListening on http://127.0.0.1:8000\nPress CTRL+c to stop\n127.0.0.1 - - [22/Dec/2017 14:24:40] \"GET / HTTP/1.1\" 200 -\n127.0.0.1 - - [22/Dec/2017 14:45:17] \"GET /README.md HTTP/1.1\" 200 -\n127.0.0.1 - - [08/Jun/2018 01:40:21] \"GET /README.md HTTP/1.1\" 200 -\n```\n\nThen open [127.0.0.1:8000](http://127.0.0.1:8000) on your browser.\n\n## Credit\n\n- [GitHub Markdown CSS](https://github.com/sindresorhus/github-markdown-css)\n- [Python Markdown](https://python-markdown.github.io/)\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Python HTTP Server for markdown files.",
"version": "1.0.2",
"split_keywords": [
"readme",
"markdown",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "f824e9d78dcf9bf495508dc32c31484e",
"sha256": "08fbc69e879378b331df0411f14c7735023341eb0f3113ddcf7d3ab45e3e672e"
},
"downloads": -1,
"filename": "ReadEm-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f824e9d78dcf9bf495508dc32c31484e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 22486,
"upload_time": "2022-12-16T18:36:23",
"upload_time_iso_8601": "2022-12-16T18:36:23.816740Z",
"url": "https://files.pythonhosted.org/packages/50/99/f773d776f920d451e0b23a190be0ace8a6b03e4bb15c802fedc13ce81787/ReadEm-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f88f15cf67d802d2069fcfa3d8bd367e",
"sha256": "bb377365bd1eab0bb1177f794ef13bf13594b08a6d7b05bacaece19dea46c1c0"
},
"downloads": -1,
"filename": "ReadEm-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f88f15cf67d802d2069fcfa3d8bd367e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 22839,
"upload_time": "2022-12-16T18:36:26",
"upload_time_iso_8601": "2022-12-16T18:36:26.315405Z",
"url": "https://files.pythonhosted.org/packages/3d/44/e4b6a83194a761dd1b766c0265ebe4b03ca4393b4073dbc80bb3037546a6/ReadEm-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-16 18:36:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jockerz",
"github_project": "ReadEm",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "Markdown",
"specs": []
}
],
"lcname": "readem"
}
JSON
