Metadata-Version: 2.1
Name: biothings
Version: 0.7.3
Summary: a toolkit for building high-performance data APIs in biology
Home-page: https://github.com/biothings/biothings.api
Author: Cyrus Afrasiabi, Sebastien Lelong, Xinghua Zhou, Chunlei Wu
Author-email: cwu@scripps.edu
License: Apache License, Version 2.0
Description: [![Downloads](https://pepy.tech/badge/biothings)](https://pepy.tech/project/biothings)
        [![biothings package](https://badge.fury.io/py/biothings.svg)](https://pypi.python.org/pypi/biothings)
        [![biothings_version](https://img.shields.io/pypi/pyversions/biothings.svg)](https://pypi.python.org/pypi/biothings)
        [![biothings_version](https://img.shields.io/pypi/format/biothings.svg)](https://pypi.python.org/pypi/biothings)
        [![biothings_version](https://img.shields.io/pypi/status/biothings.svg)](https://pypi.python.org/pypi/biothings)
        [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
        [![Build Status](https://travis-ci.org/biothings/biothings.api.svg?branch=master)](https://travis-ci.org/biothings/biothings.api)
        [![Documentation Status](https://readthedocs.org/projects/biothingsapi/badge/?version=latest)](https://docs.biothings.io/en/latest/?badge=latest)
        
        # BioThings SDK
        
        ## Quick Summary
        
        BioThings SDK provides a Python-based toolkit to build high-performance data APIs (or web services) from a single data source or multiple data sources. It has the particular focus on building data APIs for biomedical-related entities, a.k.a "BioThings" (such as genes, genetic variants, drugs, chemicals, diseases, etc.).
        
        Documentation about BioThings SDK can be found at https://docs.biothings.io
        
        ## Introduction
        
        ### What's BioThings?
        
        We use "**BioThings**" to refer to objects of any biomedical entity-type
        represented in the biological knowledge space, such as genes, genetic
        variants, drugs, chemicals, diseases, etc.
        
        ### BioThings SDK
        
        SDK represents "Software Development Kit". BioThings SDK provides a
        [Python-based](https://www.python.org/) toolkit to build
        high-performance data APIs (or web services) from a single data source
        or multiple data sources. It has the particular focus on building data
        APIs for biomedical-related entities, a.k.a "*BioThings*", though it's
        not necessarily limited to the biomedical scope. For any given
        "*BioThings*" type, BioThings SDK helps developers to aggregate
        annotations from multiple data sources, and expose them as a clean and
        high-performance web API.
        
        The BioThings SDK can be roughly divided into two main components: data
        hub (or just "hub") component and web component. The hub component
        allows developers to automate the process of monitoring, parsing and
        uploading your data source to an
        [Elasticsearch](https://www.elastic.co/products/elasticsearch) backend.
        From here, the web component, built on the high-concurrency [Tornado Web
        Server](http://www.tornadoweb.org/en/stable/) , allows you to easily
        setup a live high-performance API. The API endpoints expose
        simple-to-use yet powerful query features using [Elasticsearch's
        full-text query capabilities and query
        language](https://www.elastic.co/guide/en/elasticsearch/reference/2.4/query-dsl-query-string-query.html#query-string-syntax).
        
        ### BioThings API
        
        We also use "*BioThings API*" (or *BioThings APIs*) to refer to an API
        (or a collection of APIs) built with BioThings SDK. For example, both
        our popular [MyGene.Info](http://mygene.info/) and
        [MyVariant.Info](http://myvariant.info/) APIs are built and maintained
        using this BioThings SDK.
        
        ### BioThings Studio
        
        *BioThings Studio* is a buildin, pre-configured environment used to build and
        administer a BioThings API. At its core is the *Hub*, a backend service responsible for maintaining data up-to-date, producing data releases and
        update API frontends.
        
        ## Installing BioThings SDK
        
        You can install the latest stable BioThings SDK release with pip from
        [PyPI](https://pypi.python.org/pypi), like:
        
            pip install biothings
        
        You can install the latest development version of BioThings SDK directly
        from our github repository like:
        
            pip install git+https://github.com/biothings/biothings.api.git#egg=biothings
        
        Alternatively, you can download the source code, or clone the [BioThings
        SDK repository](https://github.com/biothings/biothings.api) and run:
        
            python setup.py install
        
        ## Get started to build a BioThings API
        
        We recommend to follow [this tutorial](https://docs.biothings.io/en/latest/doc/studio.html) to develop your first BioThings API in our pre-configured **BioThings Studio** development environment.
        
        ## Documentation
        
        The latest documentation is available at https://docs.biothings.io.
        
        ## How to contribute
        Please check out this [Contribution Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) document.
Keywords: biology annotation web service client api
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Utilities
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Description-Content-Type: text/markdown
Provides-Extra: web_extra
Provides-Extra: hub
Provides-Extra: dev
