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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ReadEm-0.1.2.tar.gz
Algorithm Hash digest
SHA256 292bb9d5962c38e0f497f0b6f0750ea867f34f41865e60f098c6b2d808278bdf
MD5 cb6be2a2af1cec88bb5fd62f8790fe13
BLAKE2b-256 8517cf4480d608a8b9f992fa246973f50568ec5df6cd7932b148f0a7ca31a576

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ReadEm-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f882162de2be6d14a8209ea21d0b376faa12863eeabe2a4c59229060059dfba0
MD5 2d0b075ab7f990031f1838c8da868ed9
BLAKE2b-256 d1e59d19c7ec5bfa80af32d2d05d139f75c593bfe9f1217e68116477fd3e50e5

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