build: move to poetry dependency management

Author: patrit

.dockerignore

@@ -1,3 +1,4 @@
+
 *
 !docs
 !gitopscli/
@@ -7,8 +8,9 @@
 !mkdocs.yml
 !Makefile
 !mypy.ini
-!requirements-docs.txt
-!requirements-test.txt
-!setup.py
+!poetry.lock
+!poetry.toml
+!pyproject.toml
+!README.md
 
-**/__pycache__/
+**/__pycache__/

.gitignore

@@ -2,12 +2,13 @@
 __pycache__
 .vscode
 .coverage
+dist/
 htmlcov/
-venv/
+.venv/
 testrepo/
 .idea
 *.iml
 .eggs/
 site/
 build/
-.mypy_cache
+.mypy_cache

.releaserc.yml

@@ -6,12 +6,12 @@ plugins:
 - "@semantic-release/release-notes-generator"
 - - "semantic-release-replace-plugin"
   - replacements:
-    - files: [ "setup.py" ]
+    - files: [ "pyproject.toml" ]
       from: "version=\"0.0.0\""
       to: "version=\"${nextRelease.version}\""
       countMatches: true
       results:
-        - file: "setup.py"
+        - file: "pyproject.toml"
           hasChanged: true
           numMatches: 1
           numReplacements: 1

Dockerfile

@@ -1,54 +1,56 @@
 # =========
-FROM python:3.10-alpine AS base
+FROM alpine:3.18 AS base
 
-ENV PATH="/opt/venv/bin:$PATH"
-RUN apk add --no-cache git
+ENV PATH="/app/.venv/bin:$PATH" \
+    PIP_DISABLE_PIP_VERSION_CHECK=1 \
+    PIP_NO_CACHE_DIR=1 \
+    PYTHONFAULTHANDLER=1 \
+    PYTHONHASHSEED=random \
+    PYTHONUNBUFFERED=1
+RUN apk add --no-cache git python3
 
 # =========
 FROM base AS dev
 
-WORKDIR /workdir
-RUN apk add --no-cache gcc linux-headers musl-dev make
-RUN python -m venv /opt/venv
-RUN python -m pip install --upgrade pip
+WORKDIR /app
+RUN apk add --no-cache gcc linux-headers musl-dev make poetry python3-dev
+COPY pyproject.toml poetry.lock poetry.toml ./
 
 # =========
 FROM dev AS deps
 
-COPY setup.py .
-RUN pip install .
+RUN poetry install --only main
 
 # =========
 FROM deps AS test
 
-COPY requirements-test.txt .
-RUN pip install -r requirements-test.txt
+RUN poetry install --with test
 COPY . .
 RUN pip install .
 RUN make checks
 
 # =========
-FROM dev AS docs
+FROM deps AS docs
 
-COPY requirements-docs.txt .
-RUN pip install -r requirements-docs.txt
+RUN poetry install --with docs
 COPY docs ./docs
 COPY CONTRIBUTING.md mkdocs.yml ./
 RUN mkdocs build
 
 # =========
 FROM scratch AS docs-site
 
-COPY --from=docs /workdir/site /site
+COPY --from=docs /app/site /site
 
 # =========
 FROM deps AS install
 
 COPY . .
-RUN pip install .
+RUN poetry build
+RUN pip install dist/gitopscli-*.whl
 
 # =========
 FROM base as final
 
-COPY --from=install /opt/venv /opt/venv
+COPY --from=install /app/.venv /app/.venv
 ENTRYPOINT ["gitopscli"]

Makefile

@@ -1,25 +1,23 @@
-BLACK_ARGS = -l 120 -t py310 gitopscli tests setup.py
+BLACK_ARGS = -l 120 -t py310 gitopscli tests
 
 init:
-	pip3 install --editable .
-	pip3 install -r requirements-test.txt
-	pip3 install -r requirements-docs.txt
+	poetry install
 	pre-commit install
 
 format:
-	python3 -m black $(BLACK_ARGS)
+	poetry run black $(BLACK_ARGS)
 
 format-check:
-	python3 -m black $(BLACK_ARGS) --check
+	poetry run black $(BLACK_ARGS) --check
 
 lint:
-	python3 -m pylint gitopscli
+	poetry run pylint gitopscli
 
 mypy:
-	python3 -m mypy --install-types --non-interactive .
+	poetry run mypy --install-types --non-interactive .
 
 test:
-	python3 -m pytest -vv -s --typeguard-packages=gitopscli
+	poetry run pytest -vv -s --typeguard-packages=gitopscli
 
 coverage:
 	coverage run -m pytest
@@ -34,4 +32,7 @@ image:
 docs:
 	mkdocs serve
 
-.PHONY: init format format-check lint mypy test coverage checks image docs
+update:
+	poetry lock
+
+.PHONY: init format format-check lint mypy test coverage checks image docs update

README.md

@@ -38,10 +38,7 @@ Currently, we support BitBucket Server, GitHub and Gitlab.
 ### Setup
 
 ```bash
-python3 -m venv venv  # create and activate virtual environment
-source venv/bin/activate  # enter virtual environment
 make init  # install dependencies, setup dev gitopscli, install pre-commit hooks, ...
-deactivate  # leave virtual environment (after development)
 ```
 
 ### Commands

poetry.lock

@@ -0,0 +1,3 @@
+[virtualenvs]
+create = true
+in-project = true

poetry.toml

@@ -0,0 +1,49 @@
+[tool.poetry]
+name = "gitopscli"
+version = "0.0.0"
+description = "GitOps CLI is a command line interface (CLI) to perform operations on GitOps managed infrastructure repositories, including updates in YAML files."
+authors = ["Christian Siegel <[email protected]>"]
+readme = "README.md"
+repository = "https://github.com/baloise/gitopscli"
+
+[tool.poetry.scripts]
+gitopscli = "gitopscli.__main__:main"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+gitpython = "==3.1.37"
+"ruamel.yaml" = "==0.16.5"
+jsonpath-ng = "==1.5.3"
+atlassian-python-api = "==1.14.5"
+pygithub = "==1.53"
+python-gitlab = "==2.6.0"
+
+[tool.poetry.group.test.dependencies]
+black = "==22.10.0"
+coverage = "==5.3"
+pylint = "==2.17.2"
+pytest = "==7.1.3"
+mypy = "==0.982"
+typeguard = "==2.13.3"
+pre-commit = "==2.20.0"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "==1.3.0"
+mkdocs-material = "==8.2.12"
+markdown-include = "==0.6.0"
+pymdown-extensions = "==10.0"
+Markdown = "==3.3.7"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.per-file-ignores]
+"**/__init__.py" = ["F401"]
+"tests/*.py" = ["E501"]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[virtualenvs]
+in-project = true