Skip to main content

Sandman inspired database and schema agnostic automatic REST API creator and data viewer/analyser

Project description

Join the chat at https://gitter.im/praxigento/damvitool http://img.shields.io/:license-lgplv3.0-green.svg?style=flat-square Latest version https://travis-ci.org/praxigento/damvitool.svg

Introduction

As stated above this project was inspired by Sandman by Jeff Knupp. At the same time damvitool improves on the original in a few important areas:

  • Support for compound queries (both for REST API and UI)

  • Extremely flexible and powerful UI (query builder wizard) thanks to SmartClient library by Isomorphic

  • Support for column summaries

  • Unlimited resulting grid (sorted&filtered) export to CSV file

Resources

Frameworks and libraries used

Versioning

Semantic Versioning 2.0.0

Todo

  • Ability to save queries

  • Extended authorisation support with fine grained control of access to queries/tables

  • Editing of records

  • Charting engine for data visualization

Quick start

Installation

Use pip to install damvitool:

$ pip install damvitool

Run damvitool from command line:

$ damvitool

When you run damvitool from command line without parameters it connects by default to the demo Chinook Database for SQLite.

To connect to your legacy database run damvitool with your database URL as parameter, like so:

$ damvitool --database sqlite:///damvitool/data/Chinook_Sqlite.sqlite

where sqlite:///damvitool/data/Chinook_Sqlite.sqlite is database URL in SQLAlchemy format (http://docs.sqlalchemy.org/en/rel_0_9/core/engines.html#database-urls).

Admin panel access

Default admin panel URL is http://localhost:8080

Build new database request

  1. Click Wizard button.

https://raw.githubusercontent.com/praxigento/damvitool/master/docs/pic1.png
  1. Login with the following credentials: user1/password1.

https://raw.githubusercontent.com/praxigento/damvitool/master/docs/pic2.png
  1. Choose root entity for your data query. If tables needed for your query don’t have relations between them you can add another root entity to your query.

https://raw.githubusercontent.com/praxigento/damvitool/master/docs/pic3.png
  1. Choose relevant entities fields.

  2. Set filter criteria.

  3. View results.

https://raw.githubusercontent.com/praxigento/damvitool/master/docs/pic4.png

Changelog

Version 0.2.0

  • Move RESTful API from /proxy/* to /api/*

  • Improved documentation

  • Fix backend and frontend e2e tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

damvitool-0.2.0.tar.gz (15.2 MB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page