README.md

PFP-API

This Repository is python codebase that packages API service for the PFP pipeline

Install the PFP-API package globally

pip install [/path/or/url/to/pfp_api-0.1.0-py3-none-any.whl]

Installing the PFP-API package in development mode

pip install -e [path/to/module/displaylab/pfp-api/]

example

 pip install -e /Users/uniqename/pfp-api/pfp-api

Running the pfp-api script- API server

    uvicorn pfp_api.api:app --reload

Once the server starts in the terminal ,use a web browser and use the url provided for example: "http://127.0.0.1:8000" to use the API service.

Installing the poetry module to run in command line

pip install -e [path/to/module/displaylab/pfp-api/python]

Running the pfp-api script with command line

    python -m pfp_api.pfp-api [path/to/the/input/file/input_spek.json] >selected_message.json