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/)



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

Uploaded Source

Built Distribution

ReadEm-0.1.4-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ReadEm-0.1.4.tar.gz
Algorithm Hash digest
SHA256 52dc988f5dd7fe60b151b872c958e8dd7a9ad91e7f3d0567f6992b5b3b7ecd7d
MD5 dee2687b7342838b20549fa36d594deb
BLAKE2b-256 47b8d77a0c8253bf706f1d2aae75219c17eafc12f31fe0c61fb5e4144442b11e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ReadEm-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0053b208072babfa3bbfed9fdd5bc5b584b0c439760c8648f5961283b06feb04
MD5 98410c55660a53fb85c2cd41958d26b9
BLAKE2b-256 97152a49389523f5494d60d04ce76d63ac53a1596f54f18832ead75171b2518e

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