Metadata-Version: 2.1
Name: atlas-consortia-commons
Version: 1.1.0
Summary: The common code supporting the web services in the consortia.
Home-page: https://github.com/x-atlas-consortia/commons
Author: Atlas Consortia
Author-email: api-developers@hubmapconsortium.org
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: Flask >=3.0.3
Requires-Dist: Werkzeug >=3.0.3
Requires-Dist: hubmap-commons >=2.1.18
Requires-Dist: jsonref ==0.3.0
Requires-Dist: jsonschema >=3.2.0
Requires-Dist: neo4j >=5.20.0
Requires-Dist: pytz >=2021.1
Requires-Dist: property >=2.2
Requires-Dist: globus-sdk >=2.0.1
Requires-Dist: prov >=1.5.1
Requires-Dist: requests >=2.32.3
Requires-Dist: PyYAML >=6.0

# commons
[![PyPI version](https://badge.fury.io/py/atlas-consortia-commons.svg)](https://badge.fury.io/py/atlas-consortia-commons)

This repository contains the code supporting several restful microservices used by the consortia.

### Getting Started

The Atlas Consortia Commons library is available through PyPi via the command:

```bash
pip install atlas-consortia-commons
```

The atlas-consortia-commons requirements can be found [here](requirements.txt)


### Contents

The code includes:
- [UBKG](atlas_consortia_commons/ubkg/README.md): For querying Unified Biomedical Knowledge Graph (UBKG) application interface
- [REST](atlas_consortia_commons/rest/README.md): For making standardised rest responses


### Coding Conventions
- Please use:
  - `snake_case` to name methods and variables. 
  - `PascalCase` for class names.
- Do follow any additional code formatting and styles as seen in the project


### Running Tests
- Install `pytest` using the command
```bash
pip install -r requirements.dev.txt
```
- Run the tests using the command
```bash
pytest
```
