# saveable-objects
A python package for checkpointing, saving, and loading objects.

[![Unit Tests](https://github.com/Christopher-K-Long/saveable-objects/actions/workflows/test-python-package.yml/badge.svg?branch=main)](https://github.com/Christopher-K-Long/saveable-objects/actions/workflows/test-python-package.yml)

## Installation

The python package can be installed with pip as follows:
```bash
pip install saveable-objects
```

The PyPI page can be found here: [https://pypi.org/project/saveable-objects](https://pypi.org/project/saveable-objects).

### Requirements:

Python >= 3.7

Packages:

- [NumPy](https://numpy.org/)
- [cloudpickle](https://github.com/cloudpipe/cloudpickle)

## Documentation

Documentation, including worked examples can be found at: [https://saveable-objects.readthedocs.io/](https://saveable-objects.readthedocs.io/).

## Source Code

Source code can be found at: [https://github.com/Christopher-K-Long/saveable-objects](https://github.com/Christopher-K-Long/saveable-objects).

A mirror can be found at: [https://gitlab.com/Christopher-K-Long/saveable-objects](https://gitlab.com/Christopher-K-Long/saveable-objects)

Please submit all [pull requests](https://github.com/Christopher-K-Long/saveable-objects/pulls), [issues](https://github.com/Christopher-K-Long/saveable-objects/issues), [discussions](https://github.com/Christopher-K-Long/saveable-objects/discussions), and [vulnerability reports](https://github.com/Christopher-K-Long/saveable-objects/security) to the [GitHub](https://github.com/Christopher-K-Long/saveable-objects) repository.


## Version and Changes

The current version is [`1.1.8`](ChangeLog.md#release-118). Please see the [Change Log](ChangeLog.md) for more
details.