Remove unused .pypirc

Author: 31ch

.gitlab-ci.yml

@@ -2,50 +2,55 @@
 default:
   image: mcr.microsoft.com/devcontainers/python:1-3.12-bookworm
 
+workflow:
+  name: '$CI_COMMIT_AUTHOR: $CI_COMMIT_TITLE'
+  auto_cancel:
+    on_new_commit: interruptible
+    on_job_failure: all
+  rules:
+    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
+      variables:
+        DEPLOY_ENV: "development"
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      variables:
+        DEPLOY_ENV: "staging"
+    - if: $CI_COMMIT_BRANCH == $CI_COMMIT_TAG
+      variables:
+        DEPLOY_ENV: "production"
+    - when: never
+
 stages:
   - build
   - test
   - deploy
 
-include:
-  - template: Jobs/Code-Quality.gitlab-ci.yml
-
 build-python-package:
   stage: build
   before_script:
-    - pipenv install --system --dev
-    - pip install packaging
+    - pip install uv
   script:
-    - echo "Building the project..."
-    - python -m build --wheel
+    - tools/build-package.sh
   artifacts:
     paths:
-      - dist
+      - 'dist/*.whl'
     expire_in: 1 week
 
 build-documentation:
   stage: build
   before_script:
-    - pipenv install --system --dev
-    - pip install -e .
-    - pip install packaging
-    - pip install tomli
-    - pip install certifi
+    - pip install uv
   script:
-    - cd docs
-    - pipenv run make html
-
-code_quality:
-  when: manual
+    - tools/build-docs.sh
+  artifacts:
+    paths:
+      - build/html/
 
 test-python-package:
   stage: test
   before_script:
-    - pipenv install --system --dev
-    - pip install -e .
+    - pip install uv
   script:
-    - echo "Running unit tests"
-    - pytest
+    - tools/test-package.sh
   coverage: '/TOTAL.*\s+(\d+%)$/'
   artifacts:
     reports:
@@ -54,10 +59,49 @@ test-python-package:
         coverage_format: cobertura
         path: coverage.xml
 
+lint-python-package:
+  stage: test
+  before_script:
+    # TODO: Add flake8-gl-codeclimate as dependency
+    - pip install flake8-gl-codeclimate
+    - pip install uv
+  script:
+    - uv run --all-extras flake8 src/python_training_project --format gl-codeclimate --output-file gl-code-quality-report.json
+  artifacts:
+    reports:
+      codequality: gl-code-quality-report.json
+
+additional-mr-checks:
+  stage: test
+  script:
+    - echo "Additional checks for merge requests"
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+
 deploy-python-package:
   stage: deploy
   before_script:
-    - pip install build twine
+    - pip install uv
+  variables:
+    UV_PUBLISH_URL: ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi
+    UV_PUBLISH_USERNAME: gitlab-ci-token
+    UV_PUBLISH_PASSWORD: ${CI_JOB_TOKEN}
+
+  script:
+    - tools/deploy-package.sh
+
+pages:
+  stage: deploy
+  script:
+    - mv build/html/ public/
+  artifacts:
+    paths:
+      - public/
+
+job-for-tags:
+  stage: deploy
   script:
-    - echo "Deploying the package..."
-    - TWINE_PASSWORD=${CI_JOB_TOKEN} TWINE_USERNAME=gitlab-ci-token python -m twine upload --repository-url ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/pypi dist/*
+    - echo "Tag pipeline"
+  rules:
+    - if: $CI_COMMIT_TAG
+    

.pypirc

@@ -71,7 +71,8 @@ pipeline {
                         ),
                         flake8(pattern: 'build/flake8.txt'),
                         pyLint(pattern: 'build/pylint.txt'),
-                        myPy(pattern: 'build/mypy.txt')
+                        myPy(pattern: 'build/mypy.txt'),
+                        pyLint(pattern: 'build/ruff.txt', id: 'ruff', name: 'Ruff')
                     ]
                 )
             }

Jenkinsfile

@@ -56,7 +56,8 @@ node {
                     ),
                     flake8(pattern: 'build/flake8.txt'),
                     pyLint(pattern: 'build/pylint.txt'),
-                    myPy(pattern: 'build/mypy.txt')
+                    myPy(pattern: 'build/mypy.txt'),
+                    pyLint(pattern: 'build/ruff.txt', id: 'ruff', name: 'Ruff')
                 ]
             )
         }

Jenkinsfile.groovy

@@ -25,6 +25,7 @@ The Python package is based on the following toolchain:
 * [Flake8](https://flake8.pycqa.org/en/latest/) for style guide enforcement
 * [mypy](https://mypy-lang.org/) for static type checking
 * [Pylint](https://www.pylint.org/) for static code analysis
+* [Ruff](https://docs.astral.sh/ruff/) for linting and code formatting
 * [pytest](https://docs.pytest.org/en/stable/) for test creation and execution
 
 

README.md

@@ -42,6 +42,7 @@ dev-dependencies = [
     "pytest",
     "pytest-cov",
     "pytest-mock",
+    "ruff",
     "sphinx",
     "sphinx-rtd-theme",
 ]
@@ -69,3 +70,11 @@ omit = [
 output = "build/test-coverage.xml"
 
 source_pkgs = ["python_training_project"]
+
+[tool.ruff]
+include = [
+    "pyproject.toml",
+    "src/**/*.py",
+    "tests/**/*.py"
+]
+output-format = "pylint"

pylint.log

@@ -1,6 +1,7 @@
 """
 The main entry point contains the command line interface.
 """
+
 import logging
 import sys
 
@@ -18,16 +19,17 @@ def cli():
     logging.basicConfig(
         stream=sys.stdout,
         level=logging.INFO,
-        format='%(asctime)s %(name)-16s %(levelname)-8s %(message)s')
+        format="%(asctime)s %(name)-16s %(levelname)-8s %(message)s",
+    )
 
 
-@cli.command(name='sum')
-@click.argument('a', type=float)
-@click.argument('b', type=float)
+@cli.command(name="sum")
+@click.argument("a", type=float)
+@click.argument("b", type=float)
 def cli_sum(a: float, b: float):
     """Show the sum of two numbers on the console."""
-    log.info('Sum of %f and %f is %f', a, b, sum(a, b))
+    log.info("Sum of %f and %f is %f", a, b, sum(a, b))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     cli()

pyproject.toml

@@ -7,4 +7,5 @@ def sum(a: float, b: float) -> float:
     """Calculate the sum of two numbers."""
     return a + b
 
+
 # TODO: add more functions here

src/python_training_project/__main__.py

@@ -16,14 +16,26 @@ if [ $? -ne 0 ]; then
     STATUS=1
 fi
 
+echo "Running mypy..."
+uv run --all-extras mypy src/python_training_project > build/mypy.txt
+if [ $? -ne 0 ]; then
+    STATUS=1
+fi
+
 echo "Running pylint..."
 uv run --all-extras pylint src/python_training_project --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" > build/pylint.txt
 if [ $? -ne 0 ]; then
     STATUS=1
 fi
 
-echo "Running mypy..."
-uv run --all-extras mypy src/python_training_project > build/mypy.txt
+echo "Running ruff check..."
+uv run --all-extras ruff check > build/ruff.txt
+if [ $? -ne 0 ]; then
+    STATUS=1
+fi
+
+echo "Running ruff format..."
+uv run --all-extras ruff format --check
 if [ $? -ne 0 ]; then
     STATUS=1
 fi