the-collector 2023.8.26
A library to store data in common formats
License: MIT
Requires Python: >=3.10
Keywords: library,robotics,robot,storage,json,pickle,gzip,csv

[![image](https://raw.githubusercontent.com/MomsFriendlyRobotCompany/the-collector/master/pics/header.jpg)](https://github.com/MomsFriendlyRobotCompany/the-collector)

# The Collector

[![.github/workflows/python.yaml](https://github.com/MomsFriendlyRobotCompany/the_collector/actions/workflows/python.yaml/badge.svg)](https://github.com/MomsFriendlyRobotCompany/the_collector/actions/workflows/python.yaml)
![GitHub](https://img.shields.io/github/license/MomsFriendlyRobotCompany/the-collector)
[![Latest Version](https://img.shields.io/pypi/v/the-collector.svg)](https://pypi.python.org/pypi/the-collector/)
[![image](https://img.shields.io/pypi/pyversions/the-collector.svg)](https://pypi.python.org/pypi/the-collector)
[![image](https://img.shields.io/pypi/format/the-collector.svg)](https://pypi.python.org/pypi/the-collector)
![PyPI - Downloads](https://img.shields.io/pypi/dm/opencv_camera?color=aqua)

**This is still under heavy development**

This was written for a class I taught on robotics. It is meant to be simple and
teach the students some things. There are probably better solutions out there,
but I like this.

Read and write data files using pickle, json, gziped
json, and csv. Method is determined by filename extension.
Valid extensions are:

- .pkl: pickle
- .json: json
- .gzip: json compressed with gzip [default]
- .csv: comma separated values

## Usage

See the [notebook](docs/notebooks/the_collector.ipynb) for examples of how to use
it.

```python
from collector import Collector

c = Collector()
c.timestamp = False
d = np.array([[1,2,3],[4.,5.,6.]])
i = {"imu":
  {
    "gyro_range": 3000,
    "accel_range": 2
  }
}

c.write("test_test_now.csv",d)
dd = c.read("test_test_now.csv")

c.write("test_test_now.json",d,i)
dd = c.read("test_test_now.json")

fname = c.write("test_test_now.pkl",d,i)
dd = c.read(fname)

c.timestamp = True
fname = c.write("data/test_test_now.pkl",d,i)
dd = c.read(fname)
# Saving 2 data points in pickle to:
# --> data/2023-08-08_18:57:52_test_test_now.pkl
# Loaded 2 data points from:
# --> data/2023-08-08_18:57:52_test_test_now.pkl
```

# The MIT License (MIT)

Copyright (c) 2017 Kevin J. Walchko

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.