Create the OpenStack Odoo Client Library for Python

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+---
+
+name: main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-github-pages:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone full tree, and checkout branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python and PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.12"
+          version: "2.16.1"
+      - name: Create virtual environment
+        run: pdm install
+      - name: Publish the docs to GitHub Pages
+        run: pdm run mike deploy --push develop

.github/workflows/tag.yml

@@ -0,0 +1,96 @@
+name: tag
+
+on:
+  push:
+    tags:
+      - "*.*.*"
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone full tree, and checkout tag
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python and PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.12"
+          version: "2.16.1"
+      - name: Build source dist and wheels
+        run: pdm build --verbose
+      - name: Upload source dist and wheels to artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 5
+          if-no-files-found: error
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-22.04
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Clone full tree, and checkout tag
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Download source dist and wheels from artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Setup Python and PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.12"
+          version: "2.16.1"
+      - name: Publish source dist and wheels to PyPI
+        run: pdm publish --no-build --verbose
+
+  publish-github-release:
+    needs: build
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+      - name: Clone and checkout tag
+        uses: actions/checkout@v4
+      - name: Download source dist and wheels from artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Extract changelog
+        id: extract-changelog
+        uses: sean0x42/markdown-extract@v2
+        with:
+          file: docs/changelog.md
+          pattern: ${{ github.ref_name }}
+      - name: Publish the GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body: ${{ steps.extract-changelog.outputs.markdown }}
+          files: dist/*
+          fail_on_unmatched_files: true
+
+  publish-github-pages:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone full tree, and checkout branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python and PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.12"
+          version: "2.16.1"
+      - name: Create virtual environment
+        run: pdm install
+      - name: Publish the docs to GitHub Pages
+        run: pdm run mike deploy --push --update-aliases ${{ github.ref_name }} latest

.github/workflows/test.yml

@@ -0,0 +1,114 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone and checkout branch
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+      - name: Run pre-commit hooks
+        uses: pre-commit/action@v3.0.1
+
+  build:
+    needs: pre-commit
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Clone full tree, and checkout branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Python and PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          python-version: "3.12"
+          version: "2.16.1"
+      - name: Build source dist and wheels
+        run: pdm build --verbose
+      - name: Upload source dist and wheels to artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 5
+          if-no-files-found: error
+
+  # test:
+  #   needs: pre-commit
+  #   permissions:
+  #     checks: write
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #         operating_system:
+  #           - ubuntu-22.04
+  #           - windows-2022
+  #         python_version:
+  #           - "3.8"
+  #           - "3.9"
+  #           - "3.10"
+  #           - "3.11"
+  #           - "3.12"
+  #   runs-on: ${{ matrix.operating_system }}
+  #   steps:
+  #     - name: Clone full tree, and checkout branch
+  #       uses: actions/checkout@v4
+  #       with:
+  #         fetch-depth: 0
+  #     - name: Setup Python and PDM
+  #       uses: pdm-project/setup-pdm@v4
+  #       with:
+  #         python-version: ${{ matrix.python_version }}
+  #         version: "2.16.1"
+  #     - name: Create virtual environment
+  #       run: pdm install
+  #     - name: Run tests
+  #       run: pdm run test
+  #     - name: Publish test results
+  #       uses: mikepenz/action-junit-report@v4
+  #       # Always run, even if the tests fail.
+  #       if: success() || failure()
+  #       with:
+  #         report_paths: rspec.xml
+  #     - name: Upload coverage report to artifacts
+  #       uses: actions/upload-artifact@v4
+  #       # Always run, even if the tests fail.
+  #       if: success() || failure()
+  #       with:
+  #         name: coverage-${{ matrix.operating_system}}-${{ matrix.python_version }}
+  #         path: coverage.xml
+  #         retention-days: 5
+  #         if-no-files-found: warn
+
+  # coverage:
+  #   needs: test
+  #   # Always run, even if the test job failed.
+  #   if: success() || failure()
+  #   runs-on: ubuntu-22.04
+  #   steps:
+  #     - name: Download coverage reports from artifacts
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         pattern: coverage-*
+  #         merge-multiple: false
+  #     - name: Generate code coverage summary report
+  #       uses: irongut/CodeCoverageSummary@v1.3.0
+  #       with:
+  #         filename: coverage-*/coverage.xml
+  #         format: markdown
+  #         hide_branch_rate: false
+  #         hide_complexity: false
+  #         indicators: false
+  #         output: both
+  #     - name: Write to job summary
+  #       run: cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -160,3 +160,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# VS Code
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+---
+# .pre-commit-config.yml
+# Pre-commit hook tasks.
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.5.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: end-of-file-fixer
+      - id: detect-private-key
+      - id: check-added-large-files
+      - id: check-merge-conflict
+  - repo: https://github.com/crate-ci/typos
+    rev: "v1.22.9"
+    hooks:
+      - id: typos
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.4.8"
+    hooks:
+      - id: ruff
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.10.0"
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - OdooRPC>=0.9.0
+          - packaging
+          - typing-extensions>=4.0.0
+  - repo: https://github.com/pdm-project/pdm
+    rev: "2.16.1"
+    hooks:
+      - id: pdm-lock-check