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 ReadEm
```


## Run

```bash
ON_A_DIRECTORY: $ python3 -m ReadEm.read_em -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: $ python3 -m ReadEm.read_em
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.1.1.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

ReadEm-0.1.1-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ReadEm-0.1.1.tar.gz
Algorithm Hash digest
SHA256 549eb969e6ed721c053ca847338eb24882491001eb17d43daf55e667493f11c7
MD5 02139bd263fd267786639ca953e0590c
BLAKE2b-256 cccee3074ca01fc637df85a3102ca3ca1648a0524334745d2eed78d275bc3922

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ReadEm-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 703836917e6bea5e9b06861b479ec3eab4bd7b15bfef1c56a6f3ed6c7e99bae1
MD5 6762d35caba96cc0f4720ee8fe2b15e1
BLAKE2b-256 176de3c79f862a844ac04005ea59ef2b182564555d5054cb1f2d3aa8454d0cbb

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