Skip to content

Latest commit

 

History

History
89 lines (67 loc) · 2.44 KB

project-base.md

File metadata and controls

89 lines (67 loc) · 2.44 KB
Raw

Project setup

Copied .devcontainer and .vscode from spatineo/python-samples and started container.

poetry

Ref:

$ poetry init \
    --name kaatio_plan_validator \
    --description "KAATIO Plan Validator" \
    --python "^3.10" \
    --license MIT \
    --no-interaction
# Some manual steps because init to a pre-existing project.
$ mkdir $(grep name pyproject.toml | cut -f2 -d '"')
echo "__version__ = \"$(grep version pyproject.toml | cut -f2 -d '"')\"" | tee kaatio_plan_validator/__init__.py
$ touch kaatio_plan_validator/main.py
$ poetry shell

Reload window.

Add dependencies

poetry add fastapi uvicorn[standard]
# Development dependencies
poetry add -D black flake8 isort pytest

Development Environment

  • Open dev container in vscode
  • Install recomended extensions
  • Open terminal
  • Run poetry install
  • Move to poetry virtual environment poetry shell
  • Select Interpreter in vscode (in the right bottom corner or Ctrl+Shift+P --> Select Interpreter): ./.venv/bin/python
    • If Interpreter is not showing "Reload window"
  • Run tests pytest
    • To run single test for example pytest -k test_model_spatial_plan_raises_error_when_plan_identifier_element_text_is_none
  • Run python run_server.py
  • Open in browser http://localhost:8000/docs

Build commands

Build locally poetry build

Build container docker-compose build

Deploy to AWS

Configure profile (example)

$ aws configure sso
SSO start URL [None]: [FILLME]
SSO Region [None]: eu-west-1
Attempting to automatically open the SSO authorization page in your default browser.
If the browser does not open or you wish to use a different device to authorize this request, open the following URL:

https://device.sso.eu-west-1.amazonaws.com/

Then enter the code:

****-****
There are X AWS accounts available to you.
Using the account ID 123456789000
The only role available to you is: AdministratorAccess
Using the role name "AdministratorAccess"
CLI default client Region [None]: eu-west-1
CLI default output format [None]: json
CLI profile name [AdministratorAccess-123456789000]: example

To use this profile, specify the profile name using --profile, as shown:

aws s3 ls --profile example

$ AWS_PROFILE=example cdk list
Stack KaatioPlanValidatorStack
$ AWS_PROFILE=example cdk deploy KaatioPlanValidatorStack