Python Package for Configuring SQL Generating APIs
Project description
Squirrels
Squirrels is an API framework for creating REST APIs that generate sql queries & dataframes dynamically from query parameters.
Setup
First, install the library and all dependencies in a new virtual environment.
# create and activate virtual environment...
pip install -e .
To confirm that the setup worked, run this to show the help page for all squirrels CLI commands:
squirrels -h
Testing
python setup.py pytest
Usage Documentation
To learn about using the squirrels framework, check out the documentation website here.
Developer Guide
From the root of the git repo, the source code can be found in the squirrels
folder and unit tests can be found in the tests
folder.
To understand what a specific squirrels command line utility is doing, start from the _command_line.py
file as your entry point.
The library version is maintained in both the setup.py
file (for the next release or release-candidate version) and the squirrels/_version.py
file (for the next release version only).
When a user initializes a squirrels project using squirrels init
, the files are copied from the squirrels/package_data/base_project
folder. The contents in the database
subfolder were constructed from the scripts in the database_elt
folder at the top level.
For the Squirrels UI activated by squirrels run
, the HTML, CSS, and Javascript files can be found in the static
and templates
subfolders of squirrels/package_data
.
License
Squirrels is released under the MIT license.
See the file LICENSE for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for squirrels-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffe71d7955bdb989dad7599d95e9f6483bd4a24d4db0116268587c612f77fbd5 |
|
MD5 | 1eeb9a97805b9cba21c7d66a8e9ad208 |
|
BLAKE2b-256 | f580a99cbb2678174d2adececbb55105611669a9ded8e72e7852d99e5f3f1cab |