A lightweight REST API implemented using FastAPI for providing read-only endpoints for the controlled vocabulary implemented in the controlled-vocabulary-utils.
Project description
controlled-vocabulary-fastapi
A lightweight REST API implemented using FastAPI for providing read-only endpoints for the controlled vocabulary implemented in the controlled-vocabulary-utils.
Use Cases
Installation
Please see the INSTALL guide for instructions.
Usage
Step 1 - Create Python virtual environment
python3 -m venv venv && source venv/bin/activate && pip install --upgrade && pip install -r requirements.txt
Step 2 - Controlled vocabulary YAML file
Prepare your controlled vocabulary YAML file.
Then copy it to ./controlled_vocabulary.yaml.
Step 3 - Launch the REST API
uvicorn main:app --reload
You can specify a different port number e.g.:
uvicorn main:app --reload --port 8082
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
To-Do/Coming Next
Please view the listing of planned improvements here.
CHANGELOG
Please view the CHANGELOG here.
License
v0.1.0 - 2025-02-23
ADDS:
- Initial implementation
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file controlled_vocabulary_fastapi-0.1.0.tar.gz.
File metadata
- Download URL: controlled_vocabulary_fastapi-0.1.0.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f63a968237a3d30e647cecd9a683f3f565b9b78db6eea6200f23f5766a3c473
|
|
| MD5 |
ac4e2e218792837b75136c78780de631
|
|
| BLAKE2b-256 |
8461054bfa8781fcf53c09df0d88e9231f31e669537e361630c731f1b34a70da
|
File details
Details for the file controlled_vocabulary_fastapi-0.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: controlled_vocabulary_fastapi-0.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a8757477dcade5e36209089ec7abd7bb2a41f621a5225227d462d7525d787fb
|
|
| MD5 |
b2460da829443e5e6481e1fb5238643c
|
|
| BLAKE2b-256 |
aa3b7d0f3d263ef51508691d427a354c29d4e0b364ec735875a14ea55d751a33
|
