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

Uploaded Source

Built Distribution

ReadEm-0.1.3-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ReadEm-0.1.3.tar.gz
Algorithm Hash digest
SHA256 253b3b000a9a4a972344bcb8fc5c2b68be88a7453249a19115437407eea0fd55
MD5 dec601bab52299a90bf7f7cde99416d7
BLAKE2b-256 37c8ebfbb97eb7ebaea325e6c523b42afdbdf19c9530e28b2e64e385c05a19c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ReadEm-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 23f4d53a432fbb112e9371b3899ae8f25468447381d4f46489ff497559569238
MD5 fcf5d860774e591c0ee57475c0c46edf
BLAKE2b-256 8d9d718b784dc4580e949157d89df39b0538d03c8c7042be161ab6bc791316ca

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