squirrels 0.2.2

Squirrels - API Framework for Data Analytics

Squirrels

Squirrels is an API framework that lets you create REST APIs for dynamic data analytics!

Documentation: https://squirrels-nest.github.io/

Source Code: https://github.com/squirrels-nest/squirrels

Table of Contents

• Main Features
• License
• Contributing to squirrels
  • Setup
  • Testing
  • Project Structure

Main Features

Here are a few of the things that squirrels can do:

• Connect to any database by specifying its sqlalchemy url without code (in squirrels.yml) or by using its native connector library in python (in connections.py).
• Configure API routes without code (in squirrels.yml) for all datasets.
• Configure parameter widgets (types include single-select, multi-select, date, number, etc.) for your datasets (in parameters.py).
• Use Jinja SQL templates (just like dbt!) or python functions (that return a pandas dataframe) to define dynamic query logic based on parameter selections.
• Query multiple databases and join the results together in a final view in one API endpoint/dataset!
• Test your API endpoints with an interactive UI or by a command line that generates rendered sql queries and results (for a given set of parameter selections).
• Define authentication logic (in auth.py) and authorize privacy scope per dataset (in squirrels.yml). The user's attributes can even be used in your query logic!

License

Squirrels is released under the MIT license.

See the file LICENSE for more details.

Contributing to squirrels

The sections below describe how to set up your local environment for squirrels development and run unit tests. A high level overview of the project structure is also provided.

Setup

This project requires python version 3.9 or above to be installed. It also uses the python build tool poetry which can be installed as follows.

Linux, MacOS, Windows (WSL):

curl -sSL https://install.python-poetry.org | python3 -

Windows (Powershell):

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

Then, to install all dependencies, run:

poetry install

And activate the virtual environment created by poetry with:

poetry shell

To confirm that the setup worked, run the following to show the help page for all squirrels CLI commands:

squirrels -h

You can enter exit to exit the virtual environment shell. You can also run poetry run squirrels -h to run squirrels commands without activating the virtual environment.

Testing

In poetry's virtual environment, run pytest.

Project Structure

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 is doing, start from the _command_line.py file as your entry point.

The library version is maintained in both the pyproject.toml and the squirrels/__init__.py files.

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.

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.