Metadata-Version: 2.1
Name: cheesebread
Version: 0.0.2
Summary: cheesebread: a toolbox for data science
Home-page: https://github.com/g4brielvs/cheesebread
Author: g4brielvs
Author-email: g4brielvs@g4brievs.me
License: GPLv3+
Keywords: toolbox,data science
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Requires-Dist: aiofiles
Requires-Dist: aiohttp
Requires-Dist: boto3
Requires-Dist: pandas (>=0.24)
Requires-Dist: requests
Requires-Dist: riprova
Requires-Dist: tqdm

cheesebread
===========

*cheesebread* is a data toolbox. In other words, it supports tools and shortcuts to 
get data from REST APIs into datasets without the hassle of explicitly handling 
every single step in the middle.

*cheesebread* handles:

  - data catalog and datasets
  - asynchronous communication to REST APIs
  - aggregate data into time series from REST APIs
  - authentication 
  - expiring tokens
  - request limits and retry on failure
  - deduplication

Rationale
^^^^^^^^^

More often than not, collectig data from REST APIs gets in the way of data analysis and  
machine learning. The toolbox implements a list of helpers that automate data collection. 

Moreover, when we are given aggregate data, for instance, an API endpoint that 
returns a user's number of interaction during a given period, the toolbox manages to create 
time series by asynchronously calling the API multiple times - a little bit hacky, but it wil get what we need. 

The toolbox is aimed to a somewhat incipient data science team whose main focus is to
get started with data analysis and not data collection. 

Versioning
^^^^^^^^^^

Always suggest a version bump. We use `Semantic Versioning <http://semver.org>`_.

Given a version number MAJOR.MINOR.PATCH, increment the:

- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.

License
^^^^^^^

Copyright (C) 2020 Gabriel Stefanini Vicente. cheesebread is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

