Metadata-Version: 2.1
Name: web-sand
Version: 2.1.4
Summary: UI for browsing/editing semantic descriptions
Home-page: https://github.com/usc-isi-i2/sand
License: MIT
Author: Binh Vu
Author-email: binh@toan2.com
Requires-Python: >=3.8,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Flask (>=2.0.2,<3.0.0)
Requires-Dist: drepr (==2.10.0-dev3)
Requires-Dist: gena (>=1.1.2,<2.0.0)
Requires-Dist: kgdata (>=2.3.0,<3.0.0)
Requires-Dist: lat_lon_parser (>=1.3.0,<2.0.0)
Requires-Dist: loguru (>=0.6.0)
Requires-Dist: orjson (>=3.6.8,<4.0.0)
Requires-Dist: peewee (>=3.14.4,<4.0.0)
Requires-Dist: python-dotenv (>=0.19.0)
Requires-Dist: sem-desc (>=3.5.2,<4.0.0)
Requires-Dist: sm-grams (>=2.1.1,<3.0.0)
Requires-Dist: tornado (>=6.1,<7.0)
Project-URL: Repository, https://github.com/usc-isi-i2/sand
Description-Content-Type: text/markdown

<h1 align="center">SAND</h1>

<div align="center">

![PyPI](https://img.shields.io/pypi/v/web-sand)
![Python](https://img.shields.io/badge/python-v3.8+-blue.svg)
[![GitHub Issues](https://img.shields.io/github/issues/usc-isi-i2/sand.svg)](https://github.com/usc-isi-i2/sand/issues)
![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

</div>

## Table of Contents

- [Introduction](#introduction)
- [Installation](#installation)

## Introduction

SAND is an application to annotate semantic descriptions of tables and (optionally) linked records in tables to a target knowledge graph, then it can automatically export the table data to RDF, JSON-LD, etc. It also does basic data cleaning automatically based on the annotated semantic descriptions. SAND is designed to be customizable: you can plug in a new semantic modeling algorithm (which generates a semantic description automatically) or different knowledge graphs as long as you have a suitable plugin implemented SAND's plugin interface.

Moreover, SAND offers an internal KG browsing and table filtering so you can interactively browsing and modeling your tables.

For a demo, please see: our [demo paper](./docs/paper.pdf), [demo video](https://github.com/usc-isi-i2/sand/wiki/Demo).

<!-- For more documentation, please see [not available yet](). -->

## Installation

Install from pip: `pip install -U web-sand`

## Usage

1. Start the webserver: `sand start -d <dbfile> --externaldb <folder_of_ent_and_ont_db>`
2. Open the URL: `http://localhost:5524`

## Development

1. Install `yarn` and [`yalc`](https://github.com/wclr/yalc)
2. Install dependencies: `yarn install`
3. Start development server: `yarn start`
4. Build production files: `yarn build`
5. Build library files and publish to private index: `yarn build:lib && yalc public --private`

