Merge branch 'pip-refactor' into 'main'

Pip refactor

See merge request johndutchover/insight-ai-api!21

.gitignore

@@ -226,8 +226,4 @@ $RECYCLE.BIN/
 *.msm
 *.msp
 *.lnk
-
-### Custom ###
-venv-fe/**
-secrets.toml
 # End of file

.gitlab-ci.yml

@@ -6,14 +6,14 @@ workflow:
     - when: never
 
 default:
-  image: python:3.11.6
+  image: python:3.11.7
 before_script:
   - apt-get update -qq && apt-get install -y curl
   - curl -L https://fly.io/install.sh | sh
   - export FLYCTL_INSTALL="/root/.fly"
   - export PATH="$FLYCTL_INSTALL/bin:$PATH"
   - python --version
-  - pip install virtualenv
+  - python -m pip install virtualenv
   - python -m venv .venv
 
 variables:
@@ -29,12 +29,14 @@ install_dependencies:
   stage: install
   script:
     - source .venv/bin/activate
-    - pip install -r app/requirements_dev.txt
-    - pip install -r app/requirements.txt
-    - pip install pre-commit
+    -  python -m pip install -r app/requirements/requirements-dev.txt
+    -  python -m pip install -r app/requirements/requirements.txt
+    -  python -m pip install pre-commit
   rules:
     - changes:
         - Makefile
+        - base.in
+        - requirements-requirements-test.in
         - requirements-dev.in
         - requirements.in
         - pyproject.toml
@@ -43,7 +45,7 @@ install_dependencies:
 
 config_changes:
   stage: test
-  image: python:3.11.6
+  image: python:3.11.7
   script:
     - source .venv/bin/activate
   rules:
@@ -55,53 +57,16 @@ config_changes:
       when: never
     - when: always
 
-#mega-linter:
-#  stage: code_quality
-#  # You can override MegaLinter flavor used to have faster performances
-#  # More info at https://megalinter.io/flavors/
-#  image: oxsecurity/megalinter-python:v7.5.0
-#  script: ["true"]
-#  variables:
-#    # All available variables are described in documentation
-#    # https://megalinter.io/configuration/
-#    DEFAULT_WORKSPACE: $CI_PROJECT_DIR
-#    # ADD YOUR CUSTOM ENV VARIABLES HERE TO OVERRIDE VALUES OF .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
-#    ENABLE_LINTERS: MAKEFILE_CHECKMAKE,PYTHON_BLACK,PYTHON_FLAKE8
-#  artifacts:
-#    when: always
-#    paths:
-#      - megalinter-reports
-#    expire_in: 1 week
-#  rules:
-#    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_BRANCH == "main"'
-#    - when: always
-#    - if: $CI_MERGE_REQUEST_TITLE =~ /^Draft:/
-#      when: never
-
 bandit:
   stage: code_quality
   script:
     - source .venv/bin/activate
-    - pip install pre-commit
+    - python -m pip install pre-commit
     - pre-commit run bandit --all-files
   rules:
     - if: '$CI_PIPELINE_SOURCE == "merge_request_event" || $CI_COMMIT_BRANCH == "main"'
     - when: always
 
-# Add a new deploy-backend-staging job
-deploy-backend-staging:
-  stage: deploy
-  script:
-    - echo "Deploy backend app to staging from $CI_COMMIT_BRANCH branch"
-    - flyctl auth token $FLY_API_TOKEN
-    - flyctl deploy --ha=false --config app/fly.staging.toml
-  environment: staging
-  rules:
-    - if: '$CI_COMMIT_BRANCH =~ /^(dev|feature-.*)$/'
-    - when: manual
-    - if: $CI_MERGE_REQUEST_TITLE =~ /^Draft:/
-      when: never
-
 deploy-backend:
   stage: deploy
   script:
@@ -114,17 +79,3 @@ deploy-backend:
     - when: manual
     - if: $CI_MERGE_REQUEST_TITLE =~ /^Draft:/
       when: never
-
-deploy-frontend:
-  stage: deploy
-  script:
-    - echo "Deploy frontend app from $CI_COMMIT_BRANCH branch"
-    - export PYTHONPATH="client/"
-    - flyctl auth token $FLY_API_TOKEN
-    - flyctl deploy --ha=false --config frontend/fly.production.toml
-  environment: production
-  rules:
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "main"'
-    - when: manual
-    - if: $CI_MERGE_REQUEST_TITLE =~ /^Draft:/
-      when: never

.pre-commit-config.yaml

@@ -1,29 +1,28 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
   - repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 24.1.1
     hooks:
       - id: black
         types:
           - python
-        args: ["--config=pyproject.toml"]
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.0.0
+    rev: 7.0.0
     hooks:
       - id: flake8
         types:
           - python
 
   - repo: https://github.com/pycqa/bandit
-    rev: 1.7.5
+    rev: 1.7.7
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml", "-ll"]

.python-version

@@ -1 +1 @@
-3.11.6
+3.11.7

README.md

@@ -21,39 +21,29 @@ This is a simplistic FastAPI app that uses AI features to enhance api service.
 
 Set Python version using pyenv
 
-`pyenv local 3.11.6`
+`pyenv local 3.11.7`
 
 - writes to `.python-version`
 
-### Initialize virtualenv
+### Initialize for development
 
 From repository root:
 
-1. `make venv`
+1. `python -m venv .venv`
 2. `source .venv/bin/activate`
+3. `python -m pip install -Ur local.in`
 
 ### Dependency management
 
 #### Makefile
 
 Makefile command table
 
-| Command                         | Purpose                                                                            |
-|---------------------------------|------------------------------------------------------------------------------------|
-| `make venv`                     | Target to create and activate the app virtual environment                          |
-| `make venv-fe`                  | Target to create and activate the frontend virtual environment                     |
-| `make app/requirements`         | Generate "app/requirements.txt" by compiling "requirements.in"                     |
-| `make app/requirements_dev`     | Generate "app/requirements_dev.txt" by compiling "requirements-dev.in"             |
-| `make app-requirements`         | Generate "app/requirements.txt" and "app/requirements_dev.txt"                     |
-| `make frontend-requirements`    | Generate "frontend/requirements_fe.txt" by compiling "requirements-fe.in"          |
-| `make cli-requirements`         | Generate "cli/requirements_fe.txt" by compiling "requirements-cli.in"              |
-| `make compile-requirements`     | Regenerate both "app/requirements.txt" and "app/requirements_dev.txt"              |
-| `make compile-requirements-dev` | Regenerate "app/requirements_dev.txt" using "pip-compile"                          |
-| `make deploy-api`               | Deploy app (api) using flyctl                                                      |
-| `make deploy-fe`                | Deploy frontend using flyctl                                                       |
-| `make sync-requirements-app`    | Synchronize .venv/ with the packages in requirements.txt  and requirements_dev.txt |
-| `make sync-requirements-cli`    | Synchronize cli/venv-cli/ with the packages in requirements_cli.txt                |
-| `make sync-requirements-fe`     | Synchronize frontend/venv-fe/ with the packages in requirements_frontend.txt       |
+| Command            | Purpose                                  |
+|--------------------|------------------------------------------|
+| `make init`        | Initialize Python environment            |
+| `make update`      | Update and Initialize Python environment |
+| `make update-deps` | Update Python dependencies               |
 
 ### GitLab CI
 
@@ -96,4 +86,8 @@ Makefile command table
 
 ### Fly
 
-- app/fly.toml
+#### Production
+- app/fly.production.toml
+
+#### Staging
+- app/fly.staging.toml