gOdoo-cli 0.13.1__tar.gz → 0.14.0__tar.gz

godoo_cli-0.14.0/.codecovrc

@@ -0,0 +1,3 @@
+[run]
+omit =
+    test_*.py

godoo_cli-0.14.0/.devcontainer/devcontainer.json

@@ -0,0 +1,103 @@
+{
+  "workspaceFolder": "/odoo/godoo_workspace",
+  // Container Settings
+  "dockerComposeFile": [
+    "../docker/docker-compose.base.yml",
+    "../docker/docker-compose.traefik.yml",
+    "../docker/docker-compose.devcontainer.yml",
+    "../docker/docker-compose.devcontainer-traefik.yml"
+  ],
+  "service": "app",
+  "shutdownAction": "stopCompose",
+  "remoteUser": "ContainerUser",
+  "initializeCommand": "./scripts/container_requirements.sh",
+  "postCreateCommand": "pre-commit install --install-hooks && echo '####################################################\nPost Create Done'",
+  "remoteEnv": {
+    "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}/" // For Docker compose workspace bindmount
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        // Python:
+        "ms-python.python",
+        "ms-python.pylint",
+        "charliermarsh.ruff",
+        "oderwat.indent-rainbow",
+        "njpwerner.autodocstring",
+        // Database:
+        "mtxr.sqltools",
+        "mtxr.sqltools-driver-pg",
+        // Odoo:
+        "jigar-patel.odoosnippets",
+        "trinhanhngoc.vscode-odoo",
+        "Odoo.owl-vision",
+        // Git Tools:
+        "eamodio.gitlens",
+        "mhutchie.git-graph",
+        "github.vscode-github-actions",
+        // XML:
+        "redhat.vscode-xml",
+        "formulahendry.auto-close-tag",
+        // CSV:
+        "mechatroner.rainbow-csv",
+        "janisdd.vscode-edit-csv",
+        // Misc:
+        "tamasfe.even-better-toml",
+        "gruntfuggly.todo-tree",
+        "naumovs.color-highlight",
+        "esbenp.prettier-vscode",
+        "yzhang.markdown-all-in-one",
+        "alefragnani.Bookmarks",
+        "stackbreak.comment-divider",
+        "tomoki1207.pdf",
+        "seatonjiang.gitmoji-vscode",
+        "bierner.markdown-mermaid",
+        // Copilot:
+        "github.copilot",
+        "github.copilot-chat"
+      ],
+      "settings": {
+        // General Settings:
+        "files.insertFinalNewline": true,
+        "editor.formatOnSave": true,
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "terminal.integrated.scrollback": 10000,
+        // Python Settings:
+        "python.pythonPath": "/odoo/venv/bin/python",
+        "python.defaultInterpreterPath": "/odoo/venv/bin/python",
+        "python.languageServer": "None", // Disable because of Odoo IDE Extension
+        "[python]": {
+          "editor.defaultFormatter": "charliermarsh.ruff",
+          "editor.codeActionsOnSave": {
+            "source.fixAll": "explicit",
+            "source.organizeImports": "explicit"
+          }
+        },
+        // XML Settings:
+        "xml.format.preserveAttributeLineBreaks": false,
+        "xml.format.joinCommentLines": false,
+        "xml.format.maxLineWidth": 0,
+        "[xml]": {
+          "editor.defaultFormatter": "redhat.vscode-xml"
+        },
+        // SQL Tools with Connection to db devcontainer:
+        "sqltools.connections": [
+          {
+            "name": "OdooDB",
+            "driver": "PostgreSQL",
+            "server": "db",
+            "port": 5432,
+            "database": "odoo",
+            "username": "odoo_user",
+            "password": "odoo"
+          }
+        ],
+        "sqltools.autoOpenSessionFiles": false,
+        "sqltools.highlightQuery": true,
+        // Misc Addons Settings:
+        "todo-tree.general.tags": ["BUG", "HACK", "FIXME", "TODO", "XXX", "[ ]", "[x]", "V16"],
+        "bookmarks.sideBar.expanded": true
+      }
+    }
+  }
+}

godoo_cli-0.14.0/.env.sample

@@ -0,0 +1,42 @@
+# ---------------------------------------------------
+# Docker Options
+WORKSPACE_IS_DEV=true # Unlock Make Reset
+TZ="Europe/Berlin"
+COMPOSE_FILE=docker-compose.base.yml:docker-compose.traefik.yml
+
+# Webserver Config:
+TRAEFIK_HOST_REGEX='godoo\.(docker\.localhost|jk\.otherdomain\.local)'
+
+# ---------------------------------------------------
+# Banner configuration that gets set on Make Stg using OdooRPC.
+#ODOO_BANNER_BG_COLOR='rgba(250, 132, 38,.6)''
+#ODOO_BANNER_TEXT="Development 1"
+
+# ---------------------------------------------------
+# Which modules not to test on "godoo test all".
+# oca stock_picking_invoicing has demo data incompatability with MRP.
+# ODOO_TEST_SKIP_MODULES="addon_name,addon_name"
+
+# ---------------------------------------------------
+# Godoo RPC Connection Values. (Login data for Odoo)
+ODOO_RPC_HOST=http://localhost:8069
+ODOO_RPC_USER=admin
+ODOO_RPC_PASSWORD=admin
+
+# ---------------------------------------------------
+# Paths (Optional):
+# ODOO_MAIN_FOLDER=/odoo/odoo
+# ODOO_MANIFEST=ODOO_MANIFEST.yml
+# ODOO_CONF_PATH=config/odoo.conf
+# ODOO_WORKSPACE_ADDON_LOCATION=addons
+# ODOO_THIRDPARTY_LOCATION=/odoo/thirdparty
+# ODOO_THIRDPARTY_ZIP_LOCATION=./thirdparty
+
+# ---------------------------------------------------
+# Database:
+ODOO_MAIN_DB=odoo
+ODOO_DB_FILTER=odoo
+ODOO_DB_PASSWORD=odoo
+ODOO_DB_USER=odoo_user
+ODOO_DB_HOST=db
+ODOO_DB_PORT=5432

godoo_cli-0.14.0/.eslintignore

@@ -0,0 +1,2 @@
+**/lib/**/*.js
+**/vendor/**/*.js

godoo_cli-0.14.0/.eslintrc.yml

@@ -0,0 +1,187 @@
+env:
+  browser: true
+  es6: true
+
+# See https://github.com/OCA/odoo-community.org/issues/37#issuecomment-470686449
+parserOptions:
+  ecmaVersion: 2019
+
+overrides:
+  - files:
+      - "**/*.esm.js"
+    parserOptions:
+      sourceType: module
+
+# Globals available in Odoo that shouldn't produce errorings
+globals:
+  _: readonly
+  $: readonly
+  fuzzy: readonly
+  jQuery: readonly
+  moment: readonly
+  odoo: readonly
+  openerp: readonly
+  owl: readonly
+
+# Styling is handled by Prettier, so we only need to enable AST rules;
+# see https://github.com/OCA/maintainer-quality-tools/pull/618#issuecomment-558576890
+rules:
+  accessor-pairs: warn
+  array-callback-return: warn
+  callback-return: warn
+  capitalized-comments:
+    - warn
+    - always
+    - ignoreConsecutiveComments: true
+      ignoreInlineComments: true
+  complexity:
+    - warn
+    - 15
+  constructor-super: warn
+  dot-notation: warn
+  eqeqeq: warn
+  global-require: warn
+  handle-callback-err: warn
+  id-blacklist: warn
+  id-match: warn
+  init-declarations: error
+  max-depth: warn
+  max-nested-callbacks: warn
+  max-statements-per-line: warn
+  no-alert: warn
+  no-array-constructor: warn
+  no-caller: warn
+  no-case-declarations: warn
+  no-class-assign: warn
+  no-cond-assign: error
+  no-const-assign: error
+  no-constant-condition: warn
+  no-control-regex: warn
+  no-debugger: error
+  no-delete-var: warn
+  no-div-regex: warn
+  no-dupe-args: error
+  no-dupe-class-members: error
+  no-dupe-keys: error
+  no-duplicate-case: error
+  no-duplicate-imports: error
+  no-else-return: warn
+  no-empty-character-class: warn
+  no-empty-function: error
+  no-empty-pattern: error
+  no-empty: warn
+  no-eq-null: error
+  no-eval: error
+  no-ex-assign: error
+  no-extend-native: warn
+  no-extra-bind: warn
+  no-extra-boolean-cast: warn
+  no-extra-label: warn
+  no-fallthrough: warn
+  no-func-assign: error
+  no-global-assign: error
+  no-implicit-coercion:
+    - warn
+    - allow: ["~"]
+  no-implicit-globals: warn
+  no-implied-eval: warn
+  no-inline-comments: warn
+  no-inner-declarations: warn
+  no-invalid-regexp: warn
+  no-irregular-whitespace: warn
+  no-iterator: warn
+  no-label-var: warn
+  no-labels: warn
+  no-lone-blocks: warn
+  no-lonely-if: error
+  no-mixed-requires: error
+  no-multi-str: warn
+  no-native-reassign: error
+  no-negated-condition: warn
+  no-negated-in-lhs: error
+  no-new-func: warn
+  no-new-object: warn
+  no-new-require: warn
+  no-new-symbol: warn
+  no-new-wrappers: warn
+  no-new: warn
+  no-obj-calls: warn
+  no-octal-escape: warn
+  no-octal: warn
+  no-param-reassign: warn
+  no-path-concat: warn
+  no-process-env: warn
+  no-process-exit: warn
+  no-proto: warn
+  no-prototype-builtins: warn
+  no-redeclare: warn
+  no-regex-spaces: warn
+  no-restricted-globals: warn
+  no-restricted-imports: warn
+  no-restricted-modules: warn
+  no-restricted-syntax: warn
+  no-return-assign: error
+  no-script-url: warn
+  no-self-assign: warn
+  no-self-compare: warn
+  no-sequences: warn
+  no-shadow-restricted-names: warn
+  no-shadow: warn
+  no-sparse-arrays: warn
+  no-sync: warn
+  no-this-before-super: warn
+  no-throw-literal: warn
+  no-undef-init: warn
+  no-undef: error
+  no-unmodified-loop-condition: warn
+  no-unneeded-ternary: error
+  no-unreachable: error
+  no-unsafe-finally: error
+  no-unused-expressions: error
+  no-unused-labels: error
+  no-unused-vars: error
+  no-use-before-define: error
+  no-useless-call: warn
+  no-useless-computed-key: warn
+  no-useless-concat: warn
+  no-useless-constructor: warn
+  no-useless-escape: warn
+  no-useless-rename: warn
+  no-void: warn
+  no-with: warn
+  operator-assignment: [error, always]
+  prefer-const: warn
+  radix: warn
+  require-yield: warn
+  sort-imports: warn
+  spaced-comment: [error, always]
+  strict: [error, function]
+  use-isnan: error
+  valid-jsdoc:
+    - warn
+    - prefer:
+        arg: param
+        argument: param
+        augments: extends
+        constructor: class
+        exception: throws
+        func: function
+        method: function
+        prop: property
+        return: returns
+        virtual: abstract
+        yield: yields
+      preferType:
+        array: Array
+        bool: Boolean
+        boolean: Boolean
+        number: Number
+        object: Object
+        str: String
+        string: String
+      requireParamDescription: false
+      requireReturn: false
+      requireReturnDescription: false
+      requireReturnType: false
+  valid-typeof: warn
+  yoda: warn

godoo_cli-0.14.0/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: joshkreud

godoo_cli-0.14.0/.github/workflows/README.md

@@ -0,0 +1,85 @@
+# 🔄 GitHub Workflows
+
+This directory contains the GitHub Actions workflows for the gOdoo project.
+
+## 📊 Workflow Overview
+
+```mermaid
+flowchart LR
+    A[PR/Push] -->|Triggers| B[quality.yml]
+    C[Manual Trigger] -->|Triggers| D[version-bump.yml]
+    D -->|Creates| E[Release PR]
+    E -->|Triggers| B
+    E -->|When Merged| F[version-publish.yml]
+    F -->|Creates| G[Tag & Release]
+    F -->|Publishes| H[PyPI Package]
+```
+
+## 📋 Workflow Details
+
+### ✅ quality.yml
+- **Triggers**: PR events, push to main, manual dispatch
+- **Actions**:
+  - Runs on Python 3.9, 3.11, and 3.12 matrix
+  - Executes formatter and linters with Hatch
+  - Runs tests with coverage reporting to Codecov
+  - Builds Docker image on main branch pushes
+  - Uses BuildX caching for efficient Docker builds
+
+### 🔢 version-bump.yml
+- **Trigger**: Manual workflow dispatch
+- **Inputs**: patch, minor, major, alpha, beta, rc
+- **Actions**:
+  - Gets current version using Hatch
+  - Bumps version according to input type
+  - Creates release branch
+  - Generates commit history as release notes
+  - Opens PR with release notes and proper labels
+
+### 📦 version-publish.yml
+- **Trigger**: Merged PR with 'release' label
+- **Actions**:
+  - Verifies proper merge state
+  - Creates Git tag with version from Hatch
+  - Creates GitHub release (prerelease for alpha/beta/rc)
+  - Builds package with Hatch
+  - Publishes to PyPI using token authentication
+
+## 🔧 Implementation Details
+
+### Python Environment
+- Uses `actions/setup-python@v5` with Hatch for dependency management
+- Handles version bumping through Hatch's versioning tools
+- Runs quality checks in consistent environments
+
+### Docker Building
+- Uses Docker BuildX with layer caching
+- Publishes to GitHub Container Registry
+- Optimized cache handling to speed up builds
+
+### CI Optimizations
+- Concurrency controls to cancel redundant workflow runs
+- Shallow clones when appropriate
+- Strategic caching of dependencies and build artifacts
+
+## 📝 Automated Processes
+
+```mermaid
+flowchart TD
+    A[Manual Trigger] -->|version-bump.yml| B[Create Release Branch]
+    B --> C[Bump Version in Package]
+    C --> D[Extract Changes from Git Log]
+    D --> E[Create PR with Release Notes]
+    E --> F[Quality Checks Run]
+    F --> G[PR Review and Merge]
+    G -->|version-publish.yml| H[Create Git Tag]
+    H --> I[Create GitHub Release]
+    I --> J[Publish to PyPI]
+```
+
+## 🔑 Key Points
+- ✅ Quality checks run automatically on every PR and push to main
+- 🔖 Version bumping requires manual trigger by maintainers
+- 🚀 Release publishing is automated after PR merge
+- 🔒 Secure token handling for PyPI publishing
+- 🐳 Docker images use multi-stage builds for optimization

godoo_cli-0.14.0/.github/workflows/quality.yml

@@ -0,0 +1,112 @@
+name: Quality
+
+concurrency:
+  # Cancel any running workflow for the same PR/branch
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, ready_for_review, auto_merge_enabled]
+
+env:
+  PYTHON_VERSION: "3.9"
+  REGISTRY: ghcr.io
+  IMAGE_NAME: "${{ github.repository }}"
+
+jobs:
+  QualityChecks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install Project Dependencies
+        run: uv sync --all-extras
+
+      - name: Run Quality Checks
+        run: uv run hatch run dev:ci
+
+      - name: Upload Coverage
+        uses: codecov/codecov-action@v5
+        if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload test results to Codecov
+        if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  docker-build:
+    runs-on: ubuntu-latest
+    needs: QualityChecks
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1 # Shallow clone sufficient for build
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Cache Docker layers
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      - name: Login to Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: "./docker/Dockerfile"
+          platforms: "linux/amd64"
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
+
+      - name: Move cache
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

godoo_cli-0.14.0/.github/workflows/version-bump.yml

@@ -0,0 +1,138 @@
+name: Version Bump
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump_type:
+        description: "Version bump type"
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+          - rc
+          - beta
+          - alpha
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  create-bump-pr:
+    name: Create Version Bump PR
+    runs-on: ubuntu-latest
+    env:
+      REPO_URL: ${{ github.server_url }}/${{ github.repository }}
+      PYTHON_VERSION: "3.12"
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install Hatch
+        uses: pypa/hatch@install
+
+      - name: Initialize Version Info
+        id: version_info
+        run: |
+          # Get current version
+          CURRENT_VERSION=$(hatch version)
+          echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Setup Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump Version and Push
+        id: bump_version
+        run: |
+          # Get new version number first
+          hatch version ${{ inputs.bump_type }}
+          NEW_VERSION=$(hatch version)
+          echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_OUTPUT
+
+          # Create release branch with new version
+          RELEASE_BRANCH="release/${NEW_VERSION}"
+          echo "RELEASE_BRANCH=$RELEASE_BRANCH" >> $GITHUB_ENV
+          git checkout -b "$RELEASE_BRANCH"
+
+          # Commit and push the changes
+          git add -A
+          git commit -m "🔖 Bump version ${{ steps.version_info.outputs.CURRENT_VERSION }} → $NEW_VERSION"
+          git push --force origin "$RELEASE_BRANCH"
+
+      - name: Generate Release Notes
+        id: changelog
+        env:
+          NEW_VERSION: ${{ steps.bump_version.outputs.NEW_VERSION }}
+          CURRENT_VERSION: ${{ steps.version_info.outputs.CURRENT_VERSION }}
+        run: |
+          # Function to get commit history
+          get_commit_history() {
+            local range="$1"
+            git log --pretty=format:"- [%s]($REPO_URL/commit/%H)" --no-merges "$range" --invert-grep --grep="Bump version" || echo "No commits found"
+          }
+
+          # Get the last version tag
+          LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
+
+          # Start generating release notes
+          {
+            echo "CONTENT<<EOF"
+            echo "# 🔖 New Release: $NEW_VERSION"
+
+            if [ -z "$LAST_TAG" ]; then
+              echo "Previous version: None (First Release)"
+              COMMITS=$(get_commit_history "HEAD^..HEAD")
+            else
+              echo "Previous version: [$LAST_TAG]($REPO_URL/releases/tag/$LAST_TAG)"
+              COMMITS=$(get_commit_history "$LAST_TAG..HEAD")
+            fi
+
+            echo
+            echo "## 📝 Summary"
+            echo
+            echo "<if this is here i was lazy>"
+            echo
+            echo "## 📝 What's new?"
+            echo
+            echo "$COMMITS"
+            echo
+            echo "EOF"
+          } >> $GITHUB_OUTPUT
+
+      - name: Create Pull Request
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { repo, owner } = context.repo;
+            const result = await github.rest.pulls.create({
+              owner,
+              repo,
+              head: process.env.RELEASE_BRANCH,
+              base: 'main',
+              title: `🔖 Release ${process.env.NEW_VERSION}`,
+              body: process.env.CONTENT,
+              maintainer_can_modify: true
+            });
+
+            // Add labels to the PR
+            await github.rest.issues.addLabels({
+              owner,
+              repo,
+              issue_number: result.data.number,
+              labels: ['release', 'automated pr']
+            });
+        env:
+          NEW_VERSION: ${{ steps.bump_version.outputs.NEW_VERSION }}
+          CONTENT: ${{ steps.changelog.outputs.CONTENT }}