Metadata-Version: 2.1
Name: squaredown
Version: 1.4.2
Summary: Customized Square interface
Home-page: https://github.com/aracnid/squaredown
License: MIT
Keywords: python,square,mongodb
Author: Jason Romano
Author-email: aracnid@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: aracnid-config (>=1.0,<2.0)
Requires-Dist: aracnid-logger (>=1.0,<2.0)
Requires-Dist: aracnid-utils (>=1.0,<2.0)
Requires-Dist: i-mongodb (>=2.0,<3.0)
Requires-Dist: squareup (>=19.1,<20.0)
Requires-Dist: tqdm (>=4.64,<5.0)
Project-URL: Repository, https://github.com/aracnid/squaredown
Description-Content-Type: text/markdown

# 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. It probably supports older versions, but they have not been tested.

- Python 3.10 or later

### Installing

Install the latest package using pip.

```bash
$ 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

```bash
$ 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

