Skip to content

README.md

Latest commit

 

History

History
54 lines (39 loc) · 1.49 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.49 KB
Raw

Python Reference

A self-contained Python cheat sheet with reference cards, templates, metadata, and the small application used to browse the cards.

Structure

Python-reference/
|-- app/          # Browser and metadata-generation scripts
|-- docs/         # Markdown reference cards grouped by Python topic
|-- metadata/     # Generated JSON index
|-- templates/    # Reusable reference-card templates
|-- todolist.md
`-- README.md

Available Topics

  • builtins/ - built-in functions such as len(), range(), and zip()
  • data-types/ - Python's core data types
  • dictionaries/ - dictionary methods
  • lists/ - list functions and methods
  • modules/ - standard-library modules
  • sets/ - set methods
  • strings/ - string methods

Each reference card begins with YAML front matter. The metadata supports search, cross-references, difficulty filters, and future use in a Flutter application. New cards should start from a file in templates/.

Run the Cheat-Sheet Browser

From the repository root:

python Python-reference/app/python_cheat_sheet.py

Enter a supported concept such as list, append, len, or filter. Enter q to quit. The browser uses os.startfile, so it is currently intended for Windows.

Rebuild the Metadata Index

The metadata exporter requires PyYAML:

python -m pip install PyYAML
python Python-reference/app/save_metadata.py

The generated index is saved as metadata/python_metadata.json.