Skip to content

README.md

Latest commit

 

History

History
43 lines (26 loc) · 1.45 KB

README.md

File metadata and controls

43 lines (26 loc) · 1.45 KB

python-hmrc-search

Install

  • set up an enviornment with pip or conda and activate it. conda create --name fast-api-3.12 python=3.12 conda activate fast-api-3.12
  • install poetry the dependency manager curl -sSL https://install.python-poetry.org | python3 -
  • install the packages poetry install --no-root or update them if installed using poetry update

Steps to start

  • start for development - poetry run fastapi dev app/main.py
  • start for production - poetry run fastapi run app/main.py

Format

poetry run black .

Sort imports

poetry run isort .

Lint

poetry run flake8 .

Test

poetry run pytest

image image

automatic swagger docs at http://localhost:8000/docs image

Support for MCP server to interact with any AI agent

You can add the MCP server with the url http://localhost:8000/mcp to any chat client that supports MCP servers like Claude, VSCode, ChatGPT and more. Once you allow the chat client to use the MCP server you can converse with it in natural language.

image