SQIP - About/Vision

(Pronounced as 'skip')

SQIP is a Python application aimed at generalizing/standardizing the CRUD operations of Auditable data for custom built Government applications. The developer interface will be a REST API and the way the data is stored is configured through IaC. The goal is to make it easy for a business to identify the different auditable data domains, have those configured during deployment of sqip and the developers easily review documentation and start making api calls day one.

Python Environment

The development workflow uses pipenv to manage the virtual environments.

File Structure

|--.github - github actions
├── app - sqip application
│   └── providers - integration providers
└── infrastructure - all environment deployments
    ├── helm 
    │   └── SQIP
    │       ├── charts
    │       └── templates
    │           └── tests
    └── terraform

The app directory contains a Flask application, run the application:

$ pipenv install --dev # init env for development
$ pipenv shell
$ export FLASK_APP=app
$ export FLASK_ENV=development
$ flask run
 * Serving Flask app "app" (lazy loading)
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 326-874-135

Check the version API:

$ curl http://127.0.0.1:5000/publish/version
0.0.1

Swagger API docs available at:

http://127.0.0.1:5000/

Run Tests Open a new terminal window and run the flask app (see above), the run:

$ pipenv shell
$ pytest

Or

$ pipenv run pytest

GitHub Actions

The file .github/workflows/main.yml contains jobs to run tests and build SQIP. The build job needs and implementation. The test job will run the code in the tests folder when code is pushed to the repository. To run Github Actions locally, use https://github.com/nektos/act. To install on macOS:

brew install nektos/tap/act

and run

act -P ubuntu-latest=nektos/act-environments-ubuntu:18.04

Design

Use Case Diagram

Package Diagram

Class Diagram

Future

In the future we would love to have a provider system that allows for different queue mechanisms and backend database's or services.