readme

SQ	CI

We read training material from the web and learn from it by doing, but how do we keep that a bit organized? I came up with an idea: this small tool. Given a 'url', it creates the entry in a markdown map and a folder and links them; in this way, you can easily jump between different sections inside your preferred ide. As you expand the map with new contents, you build some reference material, keep it local all the time, and searchable all the time on your daily coding and use it to fee your local llm :).

quick demo

in you want to check this quickly ...

just open this repo in your GitHub Codespace and run the demo as:

bash demo.sh zo

here

bash demo.sh sb

here

simple local setup:

cp ./tests/tests_zo/resources/map.yaml map_zo.yaml
cp ./tests/tests_sb/resources/map.yaml map_sb.yaml
# edit them (optionally)

if you see some error like

src.zero_to_one_hundred.exceptions.errors.SomeError: map_yaml_path None is not valid,

likely you forgot to set map.yaml or you are using an invalid one

daily usage

uv run ./main.py help
#     cp ./tests/tests_zo/resources/map.yaml map.yaml
export MAP_YAML_PATH=map.yaml
uv run ./main.py zo help

#     cp ./tests/tests_sb/resources/map.yaml map.yaml
export MAP_YAML_PATH=map.yaml
uv run ./main.py sb help

check more usage samples in demo check this snippet to change automatically venv as you move from folder to folder gist

current features

create_section = create a new section
section=https://www.cloudskillsboost.google/paths/16
uv run ./main.py zo create_section "$section"

done_section = tag a section as done
section=https://www.cloudskillsboost.google/paths/16
uv run ./main.py zo done_section "$section"

refresh_map = refresh the section map
uv run ./main.py zo refresh_map

refresh_section_contents = refresh links to sections in the readme.md(s)
uv run ./main.py zo refresh_section_contents

pdf_to_md = convert a PDF to a single Markdown file with inline images
uv run ./main.py zo pdf_to_md "/path/to/input.pdf" "/path/to/output.md"

snatch_book = snatch a book from safari
uv run ./main.py sb snatch_book https://learning.oreilly.com/library/view/rewire-your-brain/9781119895947

refresh_toc = refresh the toc with al the books info
uv run ./main.py sb refresh_toc