[ADD] xodoo: init

``xodoo`` is collection of various scripts intended to be used for odoo.
It is based on ``click-odoo`` to connect and manage odoo.

Scripts
~~~~~~~

xodoo-migrate
-------------

Migration tool intended to run various migration scripts for Odoo. It
should be used when migration scripts directly on modules do not make
sense (e.g. need to generate some customer specific data that is not
directly related with any module).

Author: oerp-odoo

.github/workflows/ci.yml

@@ -0,0 +1,81 @@
+---
+name: CI
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+  push:
+    branches:
+      - "master"
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - python-version: "3.9"
+            toxenv: "py39-15.0"
+            machine: ubuntu-22.04
+          - python-version: "3.10"
+            toxenv: "py310-16.0"
+            machine: ubuntu-22.04
+          - python-version: "3.11"
+            toxenv: "py311-16.0"
+            machine: ubuntu-22.04
+          - python-version: "3.10"
+            toxenv: "twine_check"
+            machine: ubuntu-22.04
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_USER: odoo
+          POSTGRES_PASSWORD: odoo
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options:
+          --health-cmd pg_isready --health-interval 10s --health-timeout 5s
+          --health-retries 5
+    env:
+      PGHOST: localhost
+      PGPORT: 5432
+      PGUSER: odoo
+      PGPASSWORD: odoo
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "${{ matrix.python-version }}"
+      - uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ matrix.toxenv }}
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -qq --no-install-recommends \
+            libxml2-dev libxslt1-dev \
+            libldap2-dev libsasl2-dev \
+            gettext
+          pip install tox virtualenv
+      - name: Run tox
+        run: tox -e ${{ matrix.toxenv }}
+  deploy:
+    runs-on: ubuntu-latest
+    needs:
+      - tests
+    if: startsWith(github.ref, 'refs/tags')
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+      - name: Build a binary wheel and a source tarball
+        run: pipx run build
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -5,6 +5,8 @@
 /.vscode
 pyrightconfig.json
 .venv
+src/odoo
+.tox_env
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile = black

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+---
+exclude: "^tests/data/.*$"
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: debug-statements
+      - id: fix-encoding-pragma
+        args:
+          - --remove
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        additional_dependencies: ["flake8-bugbear==20.1.4"]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.10.1
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+  - repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+      - id: black

README.rst

@@ -1,10 +1,58 @@
-click-odoo-migrate
-==================
+xodoo
+=====
 
 .. image:: https://img.shields.io/badge/license-LGPL--3-blue.svg
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-3
 
-``click-odoo-migrate`` is migration tool intended to run various migrations
-scripts for Odoo. It should be used when migration scripts on modules directly
-do not make sense (e.g. need to generate some customer specific data that is not directly related with any module).
+``xodoo`` is collection of various scripts intended to be used for odoo.
+It is based on ``click-odoo`` to connect and manage odoo.
+
+Scripts
+~~~~~~~
+
+xodoo-migrate
+-------------
+
+Migration tool intended to run various migration scripts for Odoo. It should
+be used when migration scripts directly on modules do not make sense (e.g. need
+to generate some customer specific data that is not directly related with any
+module).
+
+.. code::
+
+    Usage: xodoo-migrate [OPTIONS] PATH
+
+      PATH:  migration file or directory of migration files.
+
+      Migration file must end with .py extension and must have 'migrate' function
+      that expects 'env' argument.
+
+    Options:
+      -c, --config FILE          Specify the Odoo configuration file. Other ways
+                                 to provide it are with the ODOO_RC or
+                                 OPENERP_SERVER environment variables, or
+                                 ~/.odoorc (Odoo >= 10) or ~/.openerp_serverrc.
+      -d, --database TEXT        Specify the database name. If present, this
+                                 parameter takes precedence over the database
+                                 provided in the Odoo configuration file.
+      --log-level TEXT           Specify the logging level. Accepted values depend
+                                 on the Odoo version, and include debug, info,
+                                 warn, error.  [default: warn]
+      --logfile FILE             Specify the log file.
+      --rollback                 Rollback the transaction even if the script does
+                                 not raise an exception. Note that if the script
+                                 itself commits, this option has no effect. This
+                                 is why it is not named dry run. This option is
+                                 implied when an interactive console is started.
+      -f, --force TEXT           Specify migration file names (without extension)
+                                 to force migrate. It will migrate even if it was
+                                 already migrated. Must be subset of migration
+                                 files provided in a path.
+      -s, --sort-algorithm TEXT  Sort algorithm to sort migration files before
+                                 migration. Possible choices: sorted, natsorted
+      --help                     Show this message and exit.
+
+If you use ``--rollback`` option, make sure you do not run ``cr.commit()`` in
+your scripts, otherwise it will have no effect (script changes are automatically
+committed if they do not fail at the end of transaction).

natsort-8.4.0-py3-none-any.whl

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -0,0 +1,16 @@
+[flake8]
+max-line-length = 88
+max-complexity = 16
+# B = bugbear
+# B9 = bugbear opinionated (incl line length)
+select = C,E,F,W,B,B9
+# E203: whitespace before ':' (black behaviour)
+# E501: flake8 line length (covered by bugbear B950)
+# W503: line break before binary operator (black behaviour)
+ignore = E203,E501,W503
+exclude =
+  ./.git
+  ./src
+  ./venv*
+  ./.venv*
+  .eggs/

setup.cfg

@@ -0,0 +1,36 @@
+# Copyright 2023 Timefordev (<https://timefordev.com>)
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+import os
+
+from setuptools import find_packages, setup
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+setup(
+    name="xodoo",
+    description="Odoo CLI Tools",
+    long_description="\n".join((open(os.path.join(here, "README.rst")).read(),)),
+    use_scm_version=True,
+    packages=find_packages(),
+    include_package_data=True,
+    setup_requires=["setuptools-scm"],
+    install_requires=["click-odoo>=1.3.0", "natsort>=8.4.0"],
+    python_requires=">=3.9",
+    license="LGPLv3+",
+    author="Andrius Laukavičius",
+    author_email="info@timefordev.com",
+    url="http://github.com/oerp-odoo/xodoo",
+    classifiers=[
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: "
+        + "GNU Lesser General Public License v3 or later (LGPLv3+)",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Framework :: Odoo",
+    ],
+    entry_points="""
+        [console_scripts]
+        xodoo-migrate=xodoo.migration:main
+    """,
+)

setup.py

@@ -0,0 +1,72 @@
+import os
+import pathlib
+import subprocess
+import textwrap
+
+import pytest
+from click_odoo import odoo, odoo_bin
+
+PATH_MIG_ROOT = pathlib.Path(__file__).parent / "data"
+PATH_MIG_1 = PATH_MIG_ROOT / "mig1"
+
+# This hack is necessary because the way CliRunner patches
+# stdout is not compatible with the Odoo logging initialization
+# mechanism. Logging is therefore tested with subprocesses.
+odoo.netsvc._logger_init = True
+
+
+def _init_odoo_db(dbname, test_addons_dir=None):
+    subprocess.check_call(["createdb", dbname])
+    cmd = [odoo_bin, "-d", dbname, "-i", "base", "--stop-after-init"]
+    if test_addons_dir:
+        addons_path = [
+            os.path.join(odoo.__path__[0], "addons"),
+            os.path.join(odoo.__path__[0], "..", "addons"),
+            test_addons_dir,
+        ]
+        cmd.append("--addons-path")
+        cmd.append(",".join(addons_path))
+    subprocess.check_call(cmd)
+
+
+def _drop_db(dbname):
+    subprocess.check_call(["dropdb", dbname])
+
+
+@pytest.fixture(scope="module")
+def odoodb(request):
+    dbname = "xodoo-test-{}".format(odoo.release.version_info[0])
+    test_addons_dir = getattr(request.module, "test_addons_dir", "")
+    _init_odoo_db(dbname, test_addons_dir)
+    try:
+        yield dbname
+    finally:
+        _drop_db(dbname)
+
+
+@pytest.fixture(scope="function")
+def odoocfg(request, tmpdir):
+    addons_path = [
+        os.path.join(odoo.__path__[0], "addons"),
+        os.path.join(odoo.__path__[0], "..", "addons"),
+    ]
+    test_addons_dir = getattr(request.module, "test_addons_dir", "")
+    if test_addons_dir:
+        addons_path.append(test_addons_dir)
+    odoo_cfg = tmpdir / "odoo.cfg"
+    odoo_cfg.write(
+        textwrap.dedent(
+            """\
+        [options]
+        addons_path = {}
+    """.format(
+                ",".join(addons_path)
+            )
+        )
+    )
+    yield odoo_cfg
+
+
+@pytest.fixture
+def path_test_data(scope="package"):
+    return pathlib.Path(__file__).parent / "data"