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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ReadEm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7bcefac4bb5d316ff61e9c599a95617786ef84c8f9b48c91538db813bc921168
MD5 e708519386e498f6846582e9351b2f03
BLAKE2b-256 90fb586e0e48d98c1af11a44a71bdaca1a4664c1caf3d3b1436e5e141d8dd993

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ReadEm-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 447032f6ef43b3cc02878d9344a4f82af19e08e51cda9a7b1ed365658a65a265
MD5 83237b6ff0df5482e72f33d6a95a44bd
BLAKE2b-256 c179ac612e16097e322d2d096a666f3dad976de75e7607fd3cb08b2b283870ed

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