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
1 maintainer
Metadata
1 maintainer
Release files for controlled-vocabulary-fastapi 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| controlled_vocabulary_fastapi-0.1.0.tar.gz | 12.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| controlled_vocabulary_fastapi-0.1.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 20.2 kB
Release files / controlled_vocabulary_fastapi-0.1.0.tar.gz
| Download URL | controlled_vocabulary_fastapi-0.1.0.tar.gz |
|---|---|
| Size | 12.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6f63a968237a3d30e647cecd9a683f3f565b9b78db6eea6200f23f5766a3c473
|
|
BLAKE2b-256 checksum How to use checksums |
8461054bfa8781fcf53c09df0d88e9231f31e669537e361630c731f1b34a70da
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.12
|
Release files / controlled_vocabulary_fastapi-0.1.0-py2.py3-none-any.whl
| Download URL | controlled_vocabulary_fastapi-0.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 7.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
1a8757477dcade5e36209089ec7abd7bb2a41f621a5225227d462d7525d787fb
|
|
BLAKE2b-256 checksum How to use checksums |
aa3b7d0f3d263ef51508691d427a354c29d4e0b364ec735875a14ea55d751a33
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.10.12
|
