ontogpt-api
⛏️ An API to extract informations from text using OntoGPT
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.8%) to scientific vocabulary
Keywords
Repository
⛏️ An API to extract informations from text using OntoGPT
Basic Info
Statistics
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
An API to extract informations from text using OntoGPT.
🧑💻 Development setup
To run the API locally for development.
📥️ Clone
Clone the repository:
bash
git clone https://github.com/vemonet/ontogpt-api
cd ontogpt-api
🐣 Install dependencies
Install Hatch, this will automatically handle virtual environments and make sure all dependencies are installed when you run a script in the project:
bash
pip install --upgrade hatch
Install the dependencies in a local virtual environment:
bash
hatch -v env create
Create a .env file with your BioPortal and OpenAI API keys required to run OntoGPT:
bash
BIOPORTAL_APIKEY=XXX
OPENAI_APIKEY=XXX
🚀 Run the API
On http://localhost:8000
bash
hatch run dev
🧹 Code formatting
The code will be automatically formatted when you commit your changes using pre-commit. But you can also run the script to format the code yourself:
hatch run fmt
Check the code for errors, and if it is in accordance with the PEP8 style guide, by running flake8 and mypy:
hatch run check
♻️ Reset the environment
In case you are facing issues with dependencies not updating properly you can easily reset the virtual environment with:
bash
hatch env prune
🐳 Deploy in production with docker
Create a .env file with your BioPortal and OpenAI API keys:
bash
BIOPORTAL_APIKEY=XXX
OPENAI_APIKEY=XXX
Deploy with docker-compose:
bash
docker-compose up
Access on http://localhost:8000
Owner
- Name: Vincent Emonet
- Login: vemonet
- Kind: user
- Location: Maastricht, Netherlands
- Company: @MaastrichtU-IDS
- Website: https://vemonet.github.io
- Repositories: 203
- Profile: https://github.com/vemonet
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- orcid: https://orcid.org/0000-0002-1501-1082
email: vincent.emonet@gmail.com
given-names: Vincent Emonet
# affiliation: Institute of Data Science, Maastricht University
title: "OntoGPT API"
repository-code: https://github.com/vemonet/ontogpt-api
date-released: 2023-02-22
url: https://pypi.org/project/ontogpt-api
# doi: 10.48550/arXiv.2206.13787
GitHub Events
Total
Last Year
Committers
Last synced: about 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Vincent Emonet | v****t@g****m | 12 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0