Metadata-Version: 2.1
Name: squaredown
Version: 1.0.0a26
Summary: A set of functions to retrieve and save Square data into MongoDB.
Home-page: https://github.com/lakeannebrewhouse/squaredown
Keywords: square,mongodb
Author: Jason Romano
Author-email: aracnid@gmail.com
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: aracnid-config
Requires-Dist: aracnid-logger
Requires-Dist: aracnid-utils
Requires-Dist: i-mongodb
Requires-Dist: squareup ~=6.3
Requires-Dist: tqdm

# Squaredown

We use Square as our point of sale system for our businesses. It works really well for most applications, but it takes too long to produce reports in a way that meets our business needs and the process is just too manual. We needed an automated way to produce our customized reports either at a click of a button or on a schedule. To do that we download the Square data into a MongoDB database. This is the code that we use to connect Square to MongoDB.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

This package supports the following version of Python:

- Python 3.8 or later

### Installing

Install the latest package using pip. (We prefer pipenv.)

```
$ pip install squaredown
```

End with an example of getting some data out of the system or using it for a little demo

## Running the tests

Explain how to run the automated tests for this system

```
$ python -m pytest
```

## Usage

TODO

## Authors

- **Jason Romano** - [Aracnid](https://github.com/aracnid)

See also the list of [contributors](https://github.com/lakeannebrewhouse/squaredown/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details

