{"id":13468394,"url":"https://github.com/danijar/handout","last_synced_at":"2025-05-15T04:04:24.220Z","repository":{"id":47497460,"uuid":"146468561","full_name":"danijar/handout","owner":"danijar","description":"Turn Python scripts into handouts with Markdown and figures","archived":false,"fork":false,"pushed_at":"2021-08-28T07:48:24.000Z","size":62,"stargazers_count":2023,"open_issues_count":12,"forks_count":106,"subscribers_count":47,"default_branch":"master","last_synced_at":"2025-04-14T04:59:23.012Z","etag":null,"topics":["data-science","notebook","productivity","prototyping","python","research"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danijar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-28T15:30:22.000Z","updated_at":"2025-04-06T07:57:05.000Z","dependencies_parsed_at":"2022-08-31T13:20:44.686Z","dependency_job_id":null,"html_url":"https://github.com/danijar/handout","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danijar%2Fhandout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danijar%2Fhandout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danijar%2Fhandout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danijar%2Fhandout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danijar","download_url":"https://codeload.github.com/danijar/handout/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270641,"owners_count":22042858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-science","notebook","productivity","prototyping","python","research"],"created_at":"2024-07-31T15:01:10.045Z","updated_at":"2025-05-15T04:04:24.115Z","avatar_url":"https://github.com/danijar.png","language":"Python","readme":"# Python Handout\n\n[![PyPI](https://img.shields.io/pypi/v/handout.svg)](https://pypi.python.org/pypi/handout/#history)\n\nTurn Python scripts into handouts with Markdown comments and inline figures. An\nalternative to Jupyter notebooks without hidden state that supports any text\neditor.\n\n| Code | Handout |\n| ---- | ------- |\n| ![Code](https://i.imgur.com/YEvUB9U.png) | ![Handout](https://i.imgur.com/dEGxaAz.png) |\n\n## Getting started\n\nYou use Python Handout as a library inside a normal Python program:\n\n1. Install via `pip3 install -U handout`.\n2. Run your script via `python3 script.py`. (You can start with\n   `examples/start.py` from the repository.)\n3. Open `output/index.html` in your browser to view the result.\n4. Iterate and refresh your browser.\n\n## Features\n\nCreate the handout via `doc = handout.Handout(outdir)` to access these features:\n\n| Feature | Example |\n| ------- | ------- |\n| Add [Markdown text][markdown] as triple-quote comments. | `\"\"\"Markdown text\"\"\"` |\n| Add text via `print()` syntax. | `doc.add_text('text:', variable)` |\n| Add image from array or url. | `doc.add_image(image, 'png', width=1)` |\n| Add video from array or url. | `doc.add_video(video, 'gif', fps=30, width=1)` |\n| Add matplotlib figure. | `doc.add_figure(fig, width=1)` |\n| Add custom HTML. | `doc.add_html(string)` |\n| Insert added items and save to `\u003coutdir\u003e/index.html`. | `doc.show()` |\n\n[markdown]: https://commonmark.org/help/\n\n## Questions\n\nFeel free to create an issue on Github.\n","funding_links":[],"categories":["Python","HarmonyOS"],"sub_categories":["Windows Manager"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanijar%2Fhandout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanijar%2Fhandout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanijar%2Fhandout/lists"}