Metadata-Version: 2.1
Name: schematicpy
Version: 0.1.11
Summary: Package for data model and data ingress management
Home-page: https://github.com/Sage-Bionetworks/schematic
Keywords: schema,metadata,validation,data model,linked data
Author: Milen Nikolov
Author-email: milen.nikolov@sagebase.org
Requires-Python: >=3.7.1,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: PyYAML (>=5.4.1,<6.0.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: click-log (>=0.3.2,<0.4.0)
Requires-Dist: google-api-python-client (>=1.12.8,<2.0.0)
Requires-Dist: google-auth-httplib2 (>=0.0.4,<0.0.5)
Requires-Dist: google-auth-oauthlib (>=0.4.2,<0.5.0)
Requires-Dist: graphviz (>=0.16,<0.17)
Requires-Dist: importlib-metadata (>=1.6.0,<2.0.0); python_version < "3.8"
Requires-Dist: inflection (>=0.5.1,<0.6.0)
Requires-Dist: jsonschema (>=3.2.0,<4.0.0)
Requires-Dist: networkx (>=2.5,<3.0)
Requires-Dist: oauth2client (<4.0.0)
Requires-Dist: pandas (>=1.2.1,<2.0.0)
Requires-Dist: pygsheets (>=2.0.4,<3.0.0)
Requires-Dist: rdflib (>=5.0.0,<6.0.0)
Requires-Dist: setuptools (>=52.0.0,<53.0.0)
Requires-Dist: synapseclient (>=2.3,<2.4)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://github.com/Sage-Bionetworks/schematic
Project-URL: Repository, https://github.com/Sage-Bionetworks/schematic
Description-Content-Type: text/markdown

# Schematic
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FSage-Bionetworks%2Fschematic%2Fbadge%3Fref%3Ddevelop&style=flat)](https://actions-badge.atrox.dev/Sage-Bionetworks/schematic/goto?ref=develop) [![Documentation Status](https://readthedocs.org/projects/sage-schematic/badge/?version=develop)](https://sage-schematic.readthedocs.io/en/develop/?badge=develop)


- [Schematic](#schematic)
  - [Introduction](#introduction)
  - [Installation Requirements and Pre-requisites](#installation-requirements-and-pre-requisites)
  - [Package Setup Instructions](#package-setup-instructions)
  - [Command Line Interface](#command-line-interface)
  - [Contributing](#contributing)
  - [Contributors](#contributors)

## Introduction

SCHEMATIC is an acronym for _Schema Engine for Manifest Ingress and Curation_. The Python based infrastructure provides a _novel_ schema-based, data ingress ecosystem, that is meant to streamline the process of metadata annotation and validation for various data contributors.

## Installation Requirements and Pre-requisites

* Python 3.7.1 or higher
* [`pyenv`](https://github.com/pyenv/pyenv)
* [`poetry`](https://github.com/python-poetry/poetry)


**Important**: You need to be a registered and certified user on [`synapse.org`](https://www.synapse.org/), and also have the right permissions to download the Google credentials files from Synapse.

## Package Setup Instructions

* [Clone Project Repository](https://sage-schematic.readthedocs.io/en/develop/README.html#clone-project-repository)
* [Virtual Environment Setup](https://sage-schematic.readthedocs.io/en/develop/README.html#virtual-environment-setup)
* [Install Dependencies](https://sage-schematic.readthedocs.io/en/develop/README.html#install-dependencies)
* [Fill in Configuration File(s)](https://sage-schematic.readthedocs.io/en/develop/README.html#fill-in-configuration-file-s)
* [Obtain Credentials File(s)](https://sage-schematic.readthedocs.io/en/develop/README.html#obtain-credentials-file-s)


## Command Line Interface

* [Schematic Initialization](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-init) (_initialize mode of authentication_)

* [Metadata Manifest Validation](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-validate) (_validate metadata manifest (.csv) files_)

* [Metadata Manifest Generation](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-manifest-get) (_generate metadata manifest (.csv) files_)

* [Metadata Manifest Validation and Submission](https://sage-schematic.readthedocs.io/en/develop/cli_reference.html#schematic-model-submit) (_submission and optional validation of metadata manifest (.csv) files_)

Refer to the [docs](https://github.com/Sage-Bionetworks/schematic/tree/develop/docs/md/details.md) for more details.

## Contributing

Interested in contributing? Awesome! We follow the typical [GitHub workflow](https://guides.github.com/introduction/flow/) of forking a repo, creating a branch, and opening pull requests. For more information on how you can add or propose a change, visit our [contributing guide](CONTRIBUTION.md). To start contributing to the package, you can refer to the [Getting Started](CONTRIBUTION.md#getting-started) section in our [contributing guide](CONTRIBUTION.md).

## Contributors

Active contributors and maintainers:

- [Milen Nikolov](https://github.com/milen-sage)
- [Sujay Patil](https://github.com/sujaypatil96)
- [Bruno Grande](https://github.com/BrunoGrandePhD)
- [Xengie Doan](https://github.com/xdoan)

