Skip to main content

Python HTTP Server special for markdown.

Project description

## ReadEm

> HTTP server for readme files.

Read local README.md or any markdown file easily.
Will be useful for clone wiki of github repository or the repo clone with markdown files.
Basicly any `.md` (markdown) file.

Markdown files on current directory will be shown on navbar menu. :)


## Instalation

```bash
$ pip3 install markdown
$ pip3 install ReadEm
```


## Run

```bash
ON_A_DIRECTORY: $ python3 read_em.py -h
usage: read_em.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]

ON_A_DIRECTORY: $ read_em.py
Listening on 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
```


## Credit

- [GitHub Markdown CSS](https://github.com/sindresorhus/github-markdown-css)
- [Python Markdown](https://python-markdown.github.io/)


## License



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

ReadEm-0.0.1.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

ReadEm-0.0.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file ReadEm-0.0.1.tar.gz.

File metadata

  • Download URL: ReadEm-0.0.1.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for ReadEm-0.0.1.tar.gz
Algorithm Hash digest
SHA256 b3a73997fba08f37020185d5ad1a871be8fbb61cf17b549d7fac9f120a65abc7
MD5 4a56b6f81f681b82eefda06cf7575f52
BLAKE2b-256 d81c73f458036cc9d98afd9c65296d4ee28f320b661bf49994541086bb5f5a9c

See more details on using hashes here.

File details

Details for the file ReadEm-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ReadEm-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8ec92f64237e93bcd149135fa43d2a641ac63f55c20c5953f6773ddf52e7e133
MD5 dcc78fe0ab2b0aa38537f4ad25613b54
BLAKE2b-256 b3ef43477300e79643dec42f259639b468aae552b7df23dbe4004009a8f49eaa

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