Skip to main content

# Readme Page

A script to create a readme [GitHub Page](https://help.github.com/articles/creating-project-pages-manually) for your project. See an [example](http://fernandojunior.github.io/readme-page).

This project uses [BeautifulSoup](http://www.crummy.com/software/BeautifulSoup/), [mkdocs](http://mkdocs.github.io/mkdocs-bootstrap/) and [six](https://pythonhosted.org/six/).

## Installation & Usage

  1. Run pip install readme-page to install the script.

  2. Run readme-page to create your repository GitHub Page.

  3. Checkout the repository page at http://<your_github_username>.github.io/<repository_name>

## Contributing

See [CONTRIBUTING](https://github.com/fernandojunior/readme-page/CONTRIBUTING.md).

## License

[![CC0](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

The MIT License.

Copyright (c) 2016 [Fernando Felix do Nascimento Junior](https://github.com/fernandojunior/).

Metadata

Release files for readme-page 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for readme-page 1.0.0
File Size Uploaded Provenance
readme-page-1.0.0.tar.gz 3.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for readme-page 1.0.0
File Interpreter ABI Platform
readme_page-1.0.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 9.2 kB

Release files / readme-page-1.0.0.tar.gz

Download URL readme-page-1.0.0.tar.gz
Size 3.9 kB
Tags Source
SHA-256 checksum
How to use checksums
0b5c690503510e7599901052dac2e007307c4a2fc6ce1bae7c3075b13b70bc8c
BLAKE2b-256 checksum
How to use checksums
30f7d760272e74be1d6c4a6399721bfa7c5b03f011be8f7078535a5d2f10f5e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / readme_page-1.0.0-py2.py3-none-any.whl

Download URL readme_page-1.0.0-py2.py3-none-any.whl
Size 5.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a881532fc1b94f479eec6b62f1b8b78fa710bad05cfe5d4fb6f6596a2d1623f5
BLAKE2b-256 checksum
How to use checksums
bc89017adb3c833b3ca74a6555ba4a3f9fd95384e021b3c8c56eb94d4960349e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for readme-page 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page