https://github.com/sabadijou/srse_manchester
Ontology Lookup Service API Interaction Tool
https://github.com/sabadijou/srse_manchester
api-client ontology python
Last synced: 2 months ago
JSON representation
Ontology Lookup Service API Interaction Tool
- Host: GitHub
- URL: https://github.com/sabadijou/srse_manchester
- Owner: sabadijou
- Created: 2024-01-23T22:45:39.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-24T20:59:51.000Z (over 1 year ago)
- Last Synced: 2025-02-04T20:36:53.162Z (4 months ago)
- Topics: api-client, ontology, python
- Language: Python
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ontology Lookup Service API Interaction Tool
This repository contains a Python application designed to interact with the Ontology Lookup Service API. The tool allows users to input an ontology ID and retrieve detailed ontology information. This document provides guidelines for running the application using Docker and Python package manager.
### Run the application through Docker
Clone the repository
```bash
git clone https://github.com/sabadijou/srse_manchester.git
```
To build the Docker image and run the application using a docker container, run the following commands in your terminal:
```bash
docker build -t srse_manchester .
docker run -it --rm srse_manchester
```
### Use application as a Python package
Install the package via pip:
```bash
pip install srse-manchester
```
#### Usage
After installation, you can intract with OLS as follows:
```bash
from srse_manchester import explore_ontology
ontology_info = explore_ontology(ontology_id='hp')
ontology_info.print_content()
```
Also you can print all ontology parameters for example
```bash
print(ontology_info.lang, ontology_info.config.title, ontology_info.config.annotations)
```
### Run the application through command line
To run the application through command line, run the following commands:
```bash
git clone https://github.com/sabadijou/srse_manchester.git
cd srse_manchester
python explorer.py
```
### Run tests
To run tests, follow these steps:
```bash
pytest tests/
```