cash-lib 0.1.1__tar.gz

cash_lib-0.1.1/.gitignore

@@ -0,0 +1,198 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDE
+.idea/
+.vscode/
+
+# Debug/reproduction artifacts
+repro_*.py
+reproduce_*.py
+verify_*.py
+inspect_*.py
+debug.log
+*.db
+.cache_test_repro/
+.cash_test/
+repro_cache/
+test_async_cache/
+test_persistence_cache/
+
+# Cache directories (runtime artifacts)
+.cash/
+examples/.cash/
+examples/async_cache/
+examples/cascading_cache/
+examples/demo_explorer_cache/
+examples/demo_ipywidgets_cache/
+examples/demo_widget_cache/
+examples/my_cache/
+examples/notebook_cache_demo/
+examples/pipeline_cache/
+examples/test_reproduce_cache/
+
+# Large data files (downloaded / synthesized by example notebooks; may land
+# under examples/ or the repo root depending on the notebook's cwd).
+large_financial_data.csv
+/data/
+
+# Ad-hoc test outputs written to the repo root by example notebook cells
+# (file_tracking_demo and similar). Pattern is anchored at root so it
+# doesn't catch legitimate fixtures like examples/test_file_dep.csv.
+/test_data.csv
+/test_data.txt
+/test_numpy.txt
+/test_path.txt
+
+# Archived examples (development experiments)
+examples/archive/
+
+# Desloppify local state
+.desloppify/
+
+# Private planning documents
+planning/
+
+# Build artifacts
+dist/
+*.egg-info/
+
+# Editor / OS artifacts
+.DS_Store
+Thumbs.db
+
+
+
+WORKING_MEMORY.md
+
+# Temp output / IDE internals
+test_output.txt
+.claude/
+
+# Large example data files (not tracked in git)
+examples/large_scale_projects/data/
+examples/large_scale_projects/examples/
+
+/design/
+
+# Bench outputs (raw artifacts) — directory contents are gitignored, but the
+# frozen cost-model dataset is committed so the shipped constants are
+# reproducible. Note: ignoring `dir/` blocks descent, so we ignore `dir/*`
+# (everything inside) and then re-include the one file we want.
+benchmarks/results/*
+!benchmarks/results/ser_deser_matrix.frozen.csv
+
+# Bench scratch outputs (cost-model fit working files, etc.)
+benchmarks/_*scratch*
+
+# Planning / findings docs written by exploratory dev sessions — not part
+# of the published repo (matches the `docs/superpowers/` and `.github/planning/`
+# convention used elsewhere).
+examples/large_scale_projects/FINDINGS.md
+examples/large_scale_projects/PROJECT_PLAN.md
+
+# Superpowers working docs (specs/plans/notes; not part of the public repo)
+docs/superpowers/
+
+# Integration-test analysis tooling lives in covtools/ (tracked), but its
+# generated artifacts are not version-controlled: covrun/ holds coverage runs,
+# removal lists, and keep/redundant sets; the inventory files are regenerated
+# by analyze_integration_tests.py. Run the tooling to recreate them locally.
+covrun/
+/integration_inventory.json
+/integration_inventory.md

cash_lib-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 Cash Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cash_lib-0.1.1/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: cash-lib
+Version: 0.1.1
+Summary: Smart caching for Python — automatic dependency tracking, persistent backends, and statement-level Jupyter notebook caching.
+Project-URL: Homepage, https://github.com/galgtonold/cash
+Project-URL: Documentation, https://cash-lib.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/galgtonold/cash/issues
+Project-URL: Changelog, https://github.com/galgtonold/cash/blob/main/CHANGELOG.md
+Author: Cash Contributors
+License: MIT License
+        
+        Copyright (c) 2025-2026 Cash Contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: cache,caching,data-science,decorator,dependency-tracking,incremental-computation,ipython,jupyter,machine-learning,memoization,notebook,pandas
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: IPython
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Provides-Extra: all
+Requires-Dist: boto3<2,>=1.26; extra == 'all'
+Requires-Dist: cloudpickle<4,>=2.0; extra == 'all'
+Requires-Dist: ipynbname>=0.1; extra == 'all'
+Requires-Dist: ipython<10,>=8.0; extra == 'all'
+Requires-Dist: ipywidgets<9,>=7.0; extra == 'all'
+Requires-Dist: matplotlib<4,>=3.5; extra == 'all'
+Requires-Dist: pandas; extra == 'all'
+Requires-Dist: polars<3,>=1.0; extra == 'all'
+Requires-Dist: psutil<7,>=5.0; extra == 'all'
+Requires-Dist: pyarrow>=13.0; extra == 'all'
+Requires-Dist: redis<6,>=4.0; extra == 'all'
+Provides-Extra: cloudpickle
+Requires-Dist: cloudpickle<4,>=2.0; extra == 'cloudpickle'
+Provides-Extra: dev
+Requires-Dist: ipykernel; extra == 'dev'
+Requires-Dist: jupyter-client; extra == 'dev'
+Requires-Dist: nbclient; extra == 'dev'
+Requires-Dist: nest-asyncio; extra == 'dev'
+Requires-Dist: pandas; extra == 'dev'
+Requires-Dist: pyarrow>=13.0; extra == 'dev'
+Requires-Dist: pyinstrument<6,>=4.6; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-rerunfailures; extra == 'dev'
+Requires-Dist: pytest-subtests; extra == 'dev'
+Requires-Dist: pytest-timeout; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: scipy; extra == 'dev'
+Requires-Dist: traitlets; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.0; extra == 'docs'
+Requires-Dist: mkdocs-mermaid2-plugin>=1.2; extra == 'docs'
+Requires-Dist: mkdocs>=1.5; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.24; extra == 'docs'
+Provides-Extra: docs-test
+Requires-Dist: aiohttp>=3.9; extra == 'docs-test'
+Requires-Dist: boto3>=1.28; extra == 'docs-test'
+Requires-Dist: fakeredis>=2.0; extra == 'docs-test'
+Requires-Dist: redis<6,>=4.0; extra == 'docs-test'
+Provides-Extra: ipynbname
+Requires-Dist: ipynbname>=0.1; extra == 'ipynbname'
+Provides-Extra: memory
+Requires-Dist: psutil<7,>=5.0; extra == 'memory'
+Provides-Extra: notebook
+Requires-Dist: ipython<10,>=8.0; extra == 'notebook'
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == 'pandas'
+Requires-Dist: pyarrow>=13.0; extra == 'pandas'
+Provides-Extra: polars
+Requires-Dist: polars<3,>=1.0; extra == 'polars'
+Provides-Extra: redis
+Requires-Dist: redis<6,>=4.0; extra == 'redis'
+Provides-Extra: s3
+Requires-Dist: boto3<2,>=1.26; extra == 's3'
+Provides-Extra: sqlite
+Provides-Extra: viz
+Requires-Dist: ipywidgets<9,>=7.0; extra == 'viz'
+Requires-Dist: matplotlib<4,>=3.5; extra == 'viz'
+Description-Content-Type: text/markdown
+
+# Cash — stop re-running notebooks that haven't changed
+
+[![PyPI version](https://img.shields.io/pypi/v/cash-lib.svg)](https://pypi.org/project/cash-lib/)
+[![Downloads](https://img.shields.io/pypi/dm/cash-lib.svg)](https://pypi.org/project/cash-lib/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://pypi.org/project/cash-lib/)
+[![CI](https://github.com/galgtonold/cash/actions/workflows/ci.yml/badge.svg)](https://github.com/galgtonold/cash/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/cash-lib/badge/?version=latest)](https://cash-lib.readthedocs.io/en/latest/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![Status: Beta](https://img.shields.io/badge/status-beta-orange.svg)](#status)
+
+> **Two lines. Zero config. Restart-and-run-all in seconds instead of minutes.**
+
+```python
+import cash
+%cash_on
+```
+
+That's it. The next time you re-run the notebook, every statement that hasn't changed is **restored from cache** instead of recomputed.
+
+📺 **Watch the 90-second demo** — Cash caching a real notebook, end to end:
+
+https://github.com/user-attachments/assets/3f376660-aeb5-4794-89cc-532a04f82f32
+
+**Or try it live in your browser** — no install:
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/galgtonold/cash/blob/main/examples/try_cash_colab.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/galgtonold/cash/main?labpath=examples/try_cash_binder.ipynb)
+
+**[Read the docs →](https://cash-lib.readthedocs.io/en/latest/)**
+
+---
+
+## Why Cash is different
+
+Most caching tools cache *cells* or *function calls*. Cash caches **statements** — the individual lines inside a cell — and tracks the dependency graph between them.
+
+- **Statement-level, not cell-level.** Change one line in a 20-line cell → that line and its dependents recompute. The other 19 stay cached.
+- **Dependency-aware.** Cash builds a lineage graph. Touch `config` → only cells that read `config` (transitively) re-run.
+- **File-aware.** Cash intercepts `pd.read_csv`, `np.load`, `open`, etc. Replace `data.csv` → dependent cells recompute automatically.
+- **Mutation-aware.** `df.append(...)` and `+=` are detected, so you don't get stale reads.
+- **Survives kernel restarts.** The cache lives on disk by default. Restart, run the cell, get the value back instantly.
+- **Zero-config.** `%cash_on` and you're done. No decorators, no config file.
+
+Cash saves time on **re-runs** — restoring an unchanged result instead of recomputing it, not speeding the first execution up. The more a statement costs to compute relative to the size of its result, the more a restore saves; `%cash_stats` reports your actual numbers, and says so plainly when caching cost you time. See the [benchmarks](https://cash-lib.readthedocs.io/en/latest/benchmarks/) for how that plays out on real workloads.
+
+---
+
+## Install
+
+```bash
+pip install cash-lib
+```
+
+Optional extras: `pip install "cash-lib[all]"` (pandas, polars, redis, s3, …). See [installation](https://cash-lib.readthedocs.io/en/latest/getting-started/installation/).
+
+## Quick start
+
+**Cell 1** — turn it on:
+
+```python
+import cash
+%cash_on
+```
+
+**Cell 2** — your normal code:
+
+```python
+import pandas as pd
+df = pd.read_csv("large_dataset.csv")   # tracked: file change → recompute
+summary = df.describe()
+```
+
+Re-run the notebook:
+
+- ✅ Nothing changed → restored from cache instantly.
+- 🔄 `large_dataset.csv` changed → the cells that read it recompute.
+- ⚡ Only the analysis changed → the load stays cached, only the analysis recomputes.
+
+Cash shows a badge above each cell summarizing what it did — see [Reading the Cash badge](https://cash-lib.readthedocs.io/en/latest/badges/).
+
+## Beyond notebooks
+
+`@cash.cache` caches any Python function across processes, with the same dependency- and file-awareness. Impure functions (LLM calls, HTTP, file writes) are flagged by default, since their side effects only run on the first call.
+
+```python
+import cash
+
+@cash.cache
+def expensive(x):
+    return x ** 2 + sum(range(x))
+```
+
+Full walkthrough in [the decorator guide](https://cash-lib.readthedocs.io/en/latest/decorator/).
+
+---
+
+## Learn more
+
+- [Documentation home](https://cash-lib.readthedocs.io/en/latest/) · [Why Cash?](https://cash-lib.readthedocs.io/en/latest/why-cash/) · [Quick start](https://cash-lib.readthedocs.io/en/latest/getting-started/quickstart/)
+- [Reading the badge](https://cash-lib.readthedocs.io/en/latest/badges/) · [Magic commands](https://cash-lib.readthedocs.io/en/latest/magics/) · [Annotations](https://cash-lib.readthedocs.io/en/latest/annotations/)
+- [The decorator](https://cash-lib.readthedocs.io/en/latest/decorator/) · [Backends](https://cash-lib.readthedocs.io/en/latest/api/backends/) · [Command-line interface](https://cash-lib.readthedocs.io/en/latest/cli/)
+- [Known limitations](https://cash-lib.readthedocs.io/en/latest/known-limitations/) · [Benchmarks](https://cash-lib.readthedocs.io/en/latest/benchmarks/) · [Versioning & compatibility](https://cash-lib.readthedocs.io/en/latest/versioning/)
+
+## Status
+
+**Beta.** `0.1.1` is the first public release. The public API is stabilizing, but this is a `0.x` release — the cache format may still change between minor versions, so run `%cash_repair --full` after upgrading (see [versioning & compatibility](https://cash-lib.readthedocs.io/en/latest/versioning/)). The [known limitations](https://cash-lib.readthedocs.io/en/latest/known-limitations/) are documented honestly.
+
+Bug reports welcome: the badge has a "Report a bug" button, `%cash_feedback` prints how, or open an [issue](https://github.com/galgtonold/cash/issues).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Good first issues are [tagged on the tracker](https://github.com/galgtonold/cash/issues?q=label%3A%22good+first+issue%22).
+
+## License
+
+MIT — see [LICENSE](LICENSE).

cash_lib-0.1.1/README.md

@@ -0,0 +1,115 @@
+# Cash — stop re-running notebooks that haven't changed
+
+[![PyPI version](https://img.shields.io/pypi/v/cash-lib.svg)](https://pypi.org/project/cash-lib/)
+[![Downloads](https://img.shields.io/pypi/dm/cash-lib.svg)](https://pypi.org/project/cash-lib/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://pypi.org/project/cash-lib/)
+[![CI](https://github.com/galgtonold/cash/actions/workflows/ci.yml/badge.svg)](https://github.com/galgtonold/cash/actions/workflows/ci.yml)
+[![Docs](https://readthedocs.org/projects/cash-lib/badge/?version=latest)](https://cash-lib.readthedocs.io/en/latest/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+[![Status: Beta](https://img.shields.io/badge/status-beta-orange.svg)](#status)
+
+> **Two lines. Zero config. Restart-and-run-all in seconds instead of minutes.**
+
+```python
+import cash
+%cash_on
+```
+
+That's it. The next time you re-run the notebook, every statement that hasn't changed is **restored from cache** instead of recomputed.
+
+📺 **Watch the 90-second demo** — Cash caching a real notebook, end to end:
+
+https://github.com/user-attachments/assets/3f376660-aeb5-4794-89cc-532a04f82f32
+
+**Or try it live in your browser** — no install:
+
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/galgtonold/cash/blob/main/examples/try_cash_colab.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/galgtonold/cash/main?labpath=examples/try_cash_binder.ipynb)
+
+**[Read the docs →](https://cash-lib.readthedocs.io/en/latest/)**
+
+---
+
+## Why Cash is different
+
+Most caching tools cache *cells* or *function calls*. Cash caches **statements** — the individual lines inside a cell — and tracks the dependency graph between them.
+
+- **Statement-level, not cell-level.** Change one line in a 20-line cell → that line and its dependents recompute. The other 19 stay cached.
+- **Dependency-aware.** Cash builds a lineage graph. Touch `config` → only cells that read `config` (transitively) re-run.
+- **File-aware.** Cash intercepts `pd.read_csv`, `np.load`, `open`, etc. Replace `data.csv` → dependent cells recompute automatically.
+- **Mutation-aware.** `df.append(...)` and `+=` are detected, so you don't get stale reads.
+- **Survives kernel restarts.** The cache lives on disk by default. Restart, run the cell, get the value back instantly.
+- **Zero-config.** `%cash_on` and you're done. No decorators, no config file.
+
+Cash saves time on **re-runs** — restoring an unchanged result instead of recomputing it, not speeding the first execution up. The more a statement costs to compute relative to the size of its result, the more a restore saves; `%cash_stats` reports your actual numbers, and says so plainly when caching cost you time. See the [benchmarks](https://cash-lib.readthedocs.io/en/latest/benchmarks/) for how that plays out on real workloads.
+
+---
+
+## Install
+
+```bash
+pip install cash-lib
+```
+
+Optional extras: `pip install "cash-lib[all]"` (pandas, polars, redis, s3, …). See [installation](https://cash-lib.readthedocs.io/en/latest/getting-started/installation/).
+
+## Quick start
+
+**Cell 1** — turn it on:
+
+```python
+import cash
+%cash_on
+```
+
+**Cell 2** — your normal code:
+
+```python
+import pandas as pd
+df = pd.read_csv("large_dataset.csv")   # tracked: file change → recompute
+summary = df.describe()
+```
+
+Re-run the notebook:
+
+- ✅ Nothing changed → restored from cache instantly.
+- 🔄 `large_dataset.csv` changed → the cells that read it recompute.
+- ⚡ Only the analysis changed → the load stays cached, only the analysis recomputes.
+
+Cash shows a badge above each cell summarizing what it did — see [Reading the Cash badge](https://cash-lib.readthedocs.io/en/latest/badges/).
+
+## Beyond notebooks
+
+`@cash.cache` caches any Python function across processes, with the same dependency- and file-awareness. Impure functions (LLM calls, HTTP, file writes) are flagged by default, since their side effects only run on the first call.
+
+```python
+import cash
+
+@cash.cache
+def expensive(x):
+    return x ** 2 + sum(range(x))
+```
+
+Full walkthrough in [the decorator guide](https://cash-lib.readthedocs.io/en/latest/decorator/).
+
+---
+
+## Learn more
+
+- [Documentation home](https://cash-lib.readthedocs.io/en/latest/) · [Why Cash?](https://cash-lib.readthedocs.io/en/latest/why-cash/) · [Quick start](https://cash-lib.readthedocs.io/en/latest/getting-started/quickstart/)
+- [Reading the badge](https://cash-lib.readthedocs.io/en/latest/badges/) · [Magic commands](https://cash-lib.readthedocs.io/en/latest/magics/) · [Annotations](https://cash-lib.readthedocs.io/en/latest/annotations/)
+- [The decorator](https://cash-lib.readthedocs.io/en/latest/decorator/) · [Backends](https://cash-lib.readthedocs.io/en/latest/api/backends/) · [Command-line interface](https://cash-lib.readthedocs.io/en/latest/cli/)
+- [Known limitations](https://cash-lib.readthedocs.io/en/latest/known-limitations/) · [Benchmarks](https://cash-lib.readthedocs.io/en/latest/benchmarks/) · [Versioning & compatibility](https://cash-lib.readthedocs.io/en/latest/versioning/)
+
+## Status
+
+**Beta.** `0.1.1` is the first public release. The public API is stabilizing, but this is a `0.x` release — the cache format may still change between minor versions, so run `%cash_repair --full` after upgrading (see [versioning & compatibility](https://cash-lib.readthedocs.io/en/latest/versioning/)). The [known limitations](https://cash-lib.readthedocs.io/en/latest/known-limitations/) are documented honestly.
+
+Bug reports welcome: the badge has a "Report a bug" button, `%cash_feedback` prints how, or open an [issue](https://github.com/galgtonold/cash/issues).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). Good first issues are [tagged on the tracker](https://github.com/galgtonold/cash/issues?q=label%3A%22good+first+issue%22).
+
+## License
+
+MIT — see [LICENSE](LICENSE).