The Sample Programs Wiki Generator
Currently, the Sample Programs Wiki Generator repo houses the generate-wiki.py script which
we use in the Sample Programs repository to generate our wiki documentation. The script
is automated by a Travis CI build in the Sample Programs repo.
If you would like to propose a change, feel free to leverage the issues tab or make a pull request.
How It Works
The generate_wiki.py script works by analyzing the information in the Sample Programs
repository and storing that information in objects. These objects are then used to
generate various wiki pages in Markdown.
What is Automated
Currently, the script generates 27 pages: 1 alphabet catalog and 26 alphabet pages.
The alphabet catalog contains a table with links to each alphabet page as well as meta data like the number of scripts and languages per letter. In addition, the alphabet catalog contains the total number of scripts and languages for the entire repo.
Each alphabet page contains a table which lists each language for that particular letter as well as meta data like the number of scripts per language and links to articles and issues.
How to Run
At this time, the wiki generator is hardcoded for the Sample Programs repo. In order to run it,
you can install it as a package using pip:
pip install generate_wiki
After that, you'll need a copy of the Sample Programs repo:
git clone https://github.com/TheRenegadeCoder/sample-programs.git
Finally, you can build the wiki using the following command:
wikig /path/to/sample-programs/repo/archive
Alternatively, you can clone this repo to run the generate_wiki.py script directly:
python generate-wiki.py /path/to/sample-programs/repo/archive
Both solutions are designed to handle repo exploration from the /archive/ directory. If successful, you should
begin to see print statements for the various links under test for The Renegade Coder. When finished, you'll
have a /wiki/ directory next to your script which contains the wiki.
At this point, you can push the wiki directly to the Sample Programs wiki.
1 maintainer
Metadata
1 maintainer
Release files for generate-wiki 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| generate_wiki-1.2.0.tar.gz | 4.4 kB | Without provenance | Details |
Release files / generate_wiki-1.2.0.tar.gz
| Download URL | generate_wiki-1.2.0.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8e01fa5feb6daed69c9d23e5e35678779d2be8e1e56e066ba6792121025c29b5
|
|
BLAKE2b-256 checksum How to use checksums |
57545bff2bd5df319dd172610d9bf196040e28d7dcb1b6f074a7d9b908a37f9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7
|
Security for generate-wiki 1.2.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.
