clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-10-04 07:58:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

renamed support directories by adding leading "_" to differentiate from content.

Browse Source 
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
This commit is contained in:
Kevin Putnam
2019-07-11 11:36:11 -07:00
parent 87488cf303
commit 77552f4a9f
16 changed files with 3 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/_scripts/_python/README.md
+26
View File
@@ -0,0 +1,26 @@
bundle_lister.py
----------------
`bundle_lister.py` is a Python (3.6.0) web scraper and html file generator. First, it clones the
[clr-bundles directory](https://github.com/clearlinux/clr-bundles). Second, it parses the content of all bundles in the clr-bundles/ directory and the `packages` file. Third, it uses Jinja2 template engine to output the result as: bundles.html.txt. This file is copied to reference/bundles location, and it is invoked in `bundles.rst`, which currently appears as [Available bundles](https://clearlinux.org/documentation/clear-linux/reference/bundles).
`bundle_lister.py` automates clear linux documentation so it reflects
current bundles and packages per developer updates to the
[clr-bundles GitHub repository](https://github.com/clearlinux/clr-bundles). Therefore, it increases efficiency, automatically aligns documentation with Clear Linux Engineering development, and it eliminates potential for human error, and saves labor hours in contrast to the previous manual method.
`bundle_lister.py` will be invoked in a bash script in the `source/Makefile` of clear-linux documentation. Therefore, `bundle_lister.py` will automatically create newly scraped and parsed data upon each build of the
[website](https://clearlinux.org) and output an accurate, up-to-date table showing all bundles and packages for interested developers and admins.
See `requirements.txt` for dependencies necessary to run this application.
Built in:`Python==3.6.0`
To run `bundle_lister.py` in the terminal, enter: `python bundle_lister.py`.
Note: The `cloned_repo` directory must remain in the parent directory in order for this code to work; the template.html must remain as
well.
Note: A successful build will produce a file `bundles.html.txt` showing a table of current bundles and pundles (packages) alphabetized, with a (UTC) time and date stamp in the upper right corner.
`~$~`