lib
Folders and files
Name | Name | Last commit date | ||
---|---|---|---|---|
parent directory.. | ||||
Scripts used for generating the readme from user-contributed data PRE-REQUISITES -------------- 1. Ensure you've got Python (V 3.6+) installed on your system 2. Clone the repository, and cd into it 3. Install the dependencies: `pip install -r lib/requirements.txt` 4. Run a script, with `python lib/[name of script].py` SCRIPTS ------- - insert_contributor_content.py - Parses and inserts content from git-in-here.yml into the README.md - insert_resource_list.py - Inserts list of guides, and external resources into the README.md - insert_roadmap.py - Parses the Mermaid roadmap diagram, and inserts it + edit links into README.md - copy_resources_to_site.py - Copies resources from /guides to the website, combining with metadata - validate_pr.py - Checks newly updated git-in-here.yml to ensure it meets some of the guidelines DOCS ---- See the header of each script for more information on what it does, requirements and how to use it TESTS ----- Run `python -m unittest lib/tests/run_all_tests.py` CONFIG ------ There are some optional environmental variables that can be set before running some scripts - REPO_OWNER - The username / org where the repository is located (e.g. lissy93) - REPO_NAME - The name of the repository (e.g. git-into-open-source) - GH_ACCESS_TOKEN - A GitHub access token, required for higher rate-limit when fetching data