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.

• controlled-vocabulary-fastapi
  • Use Cases
  • Installation
  • Usage
    • Step 1 - Create Python virtual environment
    • Step 2 - Controlled vocabulary YAML file
    • Step 3 - Launch the REST API
  • Contributing
  • To-Do/Coming Next
  • CHANGELOG
  • License

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

No License

v0.1.0 - 2025-02-23

ADDS:

• Initial implementation