{"id":15043335,"url":"https://github.com/executablebooks/jupyter-cache","last_synced_at":"2025-05-16T05:04:53.506Z","repository":{"id":40422769,"uuid":"241082514","full_name":"executablebooks/jupyter-cache","owner":"executablebooks","description":"A defined interface for working with a cache of executed jupyter notebooks","archived":false,"fork":false,"pushed_at":"2025-04-07T16:47:05.000Z","size":1066,"stargazers_count":53,"open_issues_count":26,"forks_count":14,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-05-10T21:35:57.096Z","etag":null,"topics":["cached-notebooks","executed-notebooks","jupyter","jupyter-cache","jupyter-notebooks"],"latest_commit_sha":null,"homepage":"https://jupyter-cache.readthedocs.io","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/executablebooks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-17T10:42:09.000Z","updated_at":"2025-04-07T16:47:09.000Z","dependencies_parsed_at":"2023-01-31T00:45:59.190Z","dependency_job_id":"832ead3e-43e1-4c6e-88f4-b9b0f9fc8cf2","html_url":"https://github.com/executablebooks/jupyter-cache","commit_stats":{"total_commits":100,"total_committers":14,"mean_commits":7.142857142857143,"dds":0.38,"last_synced_commit":"50ee895c7b0a2e9a0365b100601f1ed5a38b1157"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fjupyter-cache","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fjupyter-cache/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fjupyter-cache/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/executablebooks%2Fjupyter-cache/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/executablebooks","download_url":"https://codeload.github.com/executablebooks/jupyter-cache/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471060,"owners_count":22076585,"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":["cached-notebooks","executed-notebooks","jupyter","jupyter-cache","jupyter-notebooks"],"created_at":"2024-09-24T20:48:52.272Z","updated_at":"2025-05-16T05:04:53.486Z","avatar_url":"https://github.com/executablebooks.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jupyter-cache\n\n[![Github-CI][github-ci]][github-link]\n[![Coverage Status][codecov-badge]][codecov-link]\n[![Documentation Status][rtd-badge]][rtd-link]\n[![Code style: black][black-badge]][black-link]\n[![PyPI][pypi-badge]][pypi-link]\n\nA defined interface for working with a cache of jupyter notebooks.\n\n## Why use jupyter-cache?\n\nIf you have a number of notebooks whose execution outputs you want to ensure are kept up to date, without having to re-execute them every time (particularly for long running code, or text-based formats that do not store the outputs).\n\nThe notebooks must have deterministic execution outputs:\n\n- You use the same environment to run them (e.g. the same installed packages)\n- They run no non-deterministic code (e.g. random numbers)\n- They do not depend on external resources (e.g. files or network connections) that change over time\n\nFor example, it is utilised by [jupyter-book](https://jupyterbook.org/content/execute.html#caching-the-notebook-execution), to allow for fast document re-builds.\n\n## Install\n\n```bash\npip install jupyter-cache\n```\n\nFor development:\n\n```bash\ngit clone https://github.com/executablebooks/jupyter-cache\ncd jupyter-cache\ngit checkout develop\npip install -e .[cli,code_style,testing]\n```\n\nSee the documentation for usage.\n\n## Development\n\nSome desired requirements (not yet all implemented):\n\n- Persistent\n- Separates out \"edits to content\" from \"edits to code cells\". Cell\n  rearranges and code cell changes should require a re-execution. Content changes should not.\n- Allow parallel access to notebooks (for execution)\n- Store execution statistics/reports\n- Store external assets: Notebooks being executed often require external assets: importing scripts/data/etc. These are prepared by the users.\n- Store execution artefacts: created during execution\n- A transparent and robust cache invalidation: imagine the user updating an external dependency or a Python module, or checking out a different git branch.\n\n## Contributing\n\njupyter-cache follows the [Executable Book Contribution Guide](https://executablebooks.org/en/latest/contributing.html). We'd love your help!\n\n### Code Style\n\nCode style is tested using [flake8](http://flake8.pycqa.org),\nwith the configuration set in `.flake8`,\nand code formatted with [black](https://github.com/ambv/black).\n\nInstalling with `jupyter-cache[code_style]` makes the [pre-commit](https://pre-commit.com/)\npackage available, which will ensure this style is met before commits are submitted, by reformatting the code\nand testing for lint errors.\nIt can be setup by:\n\n```shell\n\u003e\u003e cd jupyter-cache\n\u003e\u003e pre-commit install\n```\n\nOptionally you can run `black` and `flake8` separately:\n\n```shell\n\u003e\u003e black .\n\u003e\u003e flake8 .\n```\n\nEditors like VS Code also have automatic code reformat utilities, which can adhere to this standard.\n\n[github-ci]: https://github.com/executablebooks/jupyter-cache/workflows/continuous-integration/badge.svg?branch=master\n[github-link]: https://github.com/executablebooks/jupyter-cache\n[codecov-badge]: https://codecov.io/gh/executablebooks/jupyter-cache/branch/master/graph/badge.svg\n[codecov-link]: https://codecov.io/gh/executablebooks/jupyter-cache\n[rtd-badge]: https://readthedocs.org/projects/jupyter-cache/badge/?version=latest\n[rtd-link]: https://jupyter-cache.readthedocs.io/en/latest/?badge=latest\n[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg\n[pypi-badge]: https://img.shields.io/pypi/v/jupyter-cache.svg\n[pypi-link]: https://pypi.org/project/jupyter-cache\n[black-link]: https://github.com/ambv/black\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Fjupyter-cache","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexecutablebooks%2Fjupyter-cache","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexecutablebooks%2Fjupyter-cache/lists"}