Metadata-Version: 2.4
Name: foldlib
Version: 0.1.0
Summary: <project-description>
Author-email: Sam Griesemer <git@ord.sh>
License-Expression: MIT
Project-URL: Homepage, https://doc.olog.io/<project-name>
Project-URL: Documentation, https://doc.olog.io/<project-name>
Project-URL: Repository, https://git.olog.io/olog/<project-name>
Project-URL: Issues, https://git.olog.io/olog/<project-name>/issues
Keywords: database,orm
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Requires-Python: >=3.14
Description-Content-Type: text/markdown
Requires-Dist: tqdm
Requires-Dist: wcmatch
Requires-Dist: numpy
Requires-Dist: sqlalchemy
Requires-Dist: colorama
Provides-Extra: dev
Requires-Dist: ipykernel; extra == "dev"
Provides-Extra: doc
Requires-Dist: furo; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: sphinx-togglebutton; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# Overview
Package summary goes here, ideally with a diagram

# Install
Installation instructions

```sh
pip install <package>
```

or as a CLI tool

```sh
uv tool install <package>
```

# Development
- Initialize/synchronize the project with `uv sync`, creating a virtual
  environment with base package dependencies.
- Depending on needs, install the development dependencies with `uv sync
  --extra dev`.

## Testing
- To run the unit tests, make sure to first have the test dependencies
  installed with `uv sync --extra test`, then run `make test`.
- For notebook testing, run `make install-kernel` to make the environment
  available as a Jupyter kernel (to be selected when running notebooks).

## Documentation
- Install the documentation dependencies with `uv sync --extra doc`.
- Run `make docs-build` (optionally preceded by `make docs-clean`), and serve
  locally with `make docs-serve`.
