gOdoo-cli 0.0.4__tar.gz → 0.1.0__tar.gz

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: godoo-cli
-Version: 0.0.4
+Version: 0.1.0
 Summary: Wrapper around Odoo-Bin with some convinience RPC functions.
 License: LGPL-3
 Author: Joshua Kreuder
@@ -54,14 +54,14 @@ It's build with [Typer](https://github.com/tiangolo/typer) to provide some conve
 Deployment.
 
 Most flags can be configured by Env variables. \
-Use `godoo --help` to find out more.
+Use `godoo --help` to find out more. HINT: Install tab-completion with `godoo --install-completion`
 
 # Docker
 
 This workspace also contains Docker and Docker-Compose files. \
 
 They are used to provide either easy Odoo instances where the source is pulled according to
-[odoo_repospec.yml](./odoo_repospec.yml), or as a all batteries included devcontainer for VScode.
+[ODOO_MANIFEST.yml](./ODOO_MANIFEST.yml), or as a all batteries included devcontainer for VScode.
 
 ## Requirements
 
@@ -119,9 +119,12 @@ docker-compose up
    - If you have the Devcontainer CLI: `devcontainer open .`
    - If not open the workspace in Local Vscode. In the Command pallete search for `Reopen in container`
 4. From **within the container** start Odoo using one of the following commands:
+   - You can enable godoo tab-completion by `godoo --install-completion`
    - `make` -> Loads Odoo + Workspace Addons
    - `make bare` -> Loads Odoo with ony `web` installed.
-   - `make enterprise` -> godoo launch with install script for web_enterprise
+   - `make enterprise` -> godoo launch with `-i web_enterprise` parameter
+   - `make kill` -> Search for `odoo-bin` processes and kill them
+   - `make reset` -> Drops DB, deletes config file and datafolder
    - The full init script is available via "`godoo`". (See --help for Options)
 5. Open Odoo `https://$COMPOSE_PROJECT_NAME.docker.localhost`\
    For example `COMPOSE_PROJECT_NAME=godoo` --> [https://godoo.docker.localhost](https://godoo.docker.localhost)
@@ -171,10 +174,10 @@ Use `godoo shell` to enter an interactive shell on the Database.
 
 # Odoo Modules
 
-## Third Party Modules (repospec.yml)
+## Third Party Modules (manifest.yml)
 
 The `godoo` bootstrap function, will download some modules using git. \
-Which Repos to download is specified in `odoo_repospec.yml` ([Default](./odoo_repospec.yml)) \
+Which Repos to download is specified in `ODOO_MANIFEST.yml` ([Default](./ODOO_MANIFEST.yml)) \
 Not all of the cloned addons are automatically installed. \
 Install them via the Apps Page in Odoo using `godoo rpc modules install` or using `odoo-bin`.\
 Modules downloaded on the Odoo Marketplace can be dropped as a `.zip` archive in [./thirdparty](./thirdparty)

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/README.md

@@ -20,14 +20,14 @@ It's build with [Typer](https://github.com/tiangolo/typer) to provide some conve
 Deployment.
 
 Most flags can be configured by Env variables. \
-Use `godoo --help` to find out more.
+Use `godoo --help` to find out more. HINT: Install tab-completion with `godoo --install-completion`
 
 # Docker
 
 This workspace also contains Docker and Docker-Compose files. \
 
 They are used to provide either easy Odoo instances where the source is pulled according to
-[odoo_repospec.yml](./odoo_repospec.yml), or as a all batteries included devcontainer for VScode.
+[ODOO_MANIFEST.yml](./ODOO_MANIFEST.yml), or as a all batteries included devcontainer for VScode.
 
 ## Requirements
 
@@ -85,9 +85,12 @@ docker-compose up
    - If you have the Devcontainer CLI: `devcontainer open .`
    - If not open the workspace in Local Vscode. In the Command pallete search for `Reopen in container`
 4. From **within the container** start Odoo using one of the following commands:
+   - You can enable godoo tab-completion by `godoo --install-completion`
    - `make` -> Loads Odoo + Workspace Addons
    - `make bare` -> Loads Odoo with ony `web` installed.
-   - `make enterprise` -> godoo launch with install script for web_enterprise
+   - `make enterprise` -> godoo launch with `-i web_enterprise` parameter
+   - `make kill` -> Search for `odoo-bin` processes and kill them
+   - `make reset` -> Drops DB, deletes config file and datafolder
    - The full init script is available via "`godoo`". (See --help for Options)
 5. Open Odoo `https://$COMPOSE_PROJECT_NAME.docker.localhost`\
    For example `COMPOSE_PROJECT_NAME=godoo` --> [https://godoo.docker.localhost](https://godoo.docker.localhost)
@@ -137,10 +140,10 @@ Use `godoo shell` to enter an interactive shell on the Database.
 
 # Odoo Modules
 
-## Third Party Modules (repospec.yml)
+## Third Party Modules (manifest.yml)
 
 The `godoo` bootstrap function, will download some modules using git. \
-Which Repos to download is specified in `odoo_repospec.yml` ([Default](./odoo_repospec.yml)) \
+Which Repos to download is specified in `ODOO_MANIFEST.yml` ([Default](./ODOO_MANIFEST.yml)) \
 Not all of the cloned addons are automatically installed. \
 Install them via the Apps Page in Odoo using `godoo rpc modules install` or using `odoo-bin`.\
 Modules downloaded on the Odoo Marketplace can be dropped as a `.zip` archive in [./thirdparty](./thirdparty)

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "gOdoo-cli"
-version = "0.0.4"
+version = "0.1.0"
 description = "Wrapper around Odoo-Bin with some convinience RPC functions."
 authors = ["Joshua Kreuder <Joshua_Kreuder@outlook.com>"]
 license = "LGPL-3"

godoo_cli-0.1.0/setup.py

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+from setuptools import setup
+
+package_dir = \
+{'': 'src'}
+
+packages = \
+['godoo_cli',
+ 'godoo_cli.commands',
+ 'godoo_cli.commands.rpc',
+ 'godoo_cli.git',
+ 'godoo_cli.helpers']
+
+package_data = \
+{'': ['*']}
+
+install_requires = \
+['gitpython==3.1.27',
+ 'godoo-rpc==0.0.3',
+ 'openupgradelib==3.3.4',
+ 'python-dotenv==0.20.0',
+ 'rich==12.6.0',
+ 'ruamel-yaml==0.17.21',
+ 'typer[all]>=0.7.0,<0.8.0']
+
+extras_require = \
+{'codequality': ['pylint-odoo==8.0.16',
+                 'black==22.10.0',
+                 'isort==5.10.1',
+                 'flake8==5.0.4'],
+ 'devcontainer': ['ipdb==0.13.9',
+                  'debugpy==1.6.0',
+                  'pre-commit==2.20.0',
+                  'watchdog==2.1.7',
+                  'py-spy==0.3.11',
+                  'rope==0.23.0']}
+
+entry_points = \
+{'console_scripts': ['godoo = godoo_cli:launch_cli']}
+
+setup_kwargs = {
+    'name': 'godoo-cli',
+    'version': '0.1.0',
+    'description': 'Wrapper around Odoo-Bin with some convinience RPC functions.',
+    'long_description': '# gOdoo Dev Environment\n\n![OdooLogo](https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/odoo_logo.png)\n![ComposeLogo](https://raw.githubusercontent.com/docker/compose/v2/logo.png)\n\n**gOdoo** is short for **go Odoo**. \\\nIt is a [Vscode Devcontainer](https://code.visualstudio.com/docs/remote/containers) Environment for [Odoo](https://odoo.com/)\nwith Python CLI `godoo` convenience wrapper around `odoo-bin`.\n\nThis repository is the base source for the Python package [godoo-cli](https://pypi.org/project/godoo-cli/) and serves as\nan all batteries included development environment.\n\nMade Possible by: [WEMPE Elektronic GmbH](https://wetech.de)\n\n# gOdoo-cli\n\nPython package that provides `godoo` command line interface around `odoo-bin`.\n\nIt\'s build with [Typer](https://github.com/tiangolo/typer) to provide some convenience Wrappers for Odoo development and\nDeployment.\n\nMost flags can be configured by Env variables. \\\nUse `godoo --help` to find out more. HINT: Install tab-completion with `godoo --install-completion`\n\n# Docker\n\nThis workspace also contains Docker and Docker-Compose files. \\\n\nThey are used to provide either easy Odoo instances where the source is pulled according to\n[ODOO_MANIFEST.yml](./ODOO_MANIFEST.yml), or as a all batteries included devcontainer for VScode.\n\n## Requirements\n\n- [Docker Compose](https://github.com/docker/compose)\n- [Traefik](https://doc.traefik.io/traefik/) container running with docker provider and "traefik" named docker network.\n  Example: [Traefik Devproxy](https://github.com/joshkreud/traefik_devproxy)\n- SSH Agent running. (check `echo $SSH_AUTH_SOCK`)\\\n  This gets passed trough in the Buildprocess to clone Thirdparty repos.\n\n## Just wanna have a quick and easy Odoo Instance?\n\n```bash\ngit clone https://github.com/OpenJKSoftware/gOdoo\ncd godoo\n. scripts/container_requirements.sh # Check Requirements\ndocker-compose build\ndocker-compose up\n# wait......\n# wait a bit mode ...\n# just a little bit longer ..\n# There we go.\n# Odoo should be reachable on \'https://godoo.docker.localhost\' assuming you didn\'t change .env TRAEFIK_HOST_RULE or COMPOSE_PROJECT_NAME\n```\n\n# Devcontainer\n\n## Features\n\n- All batteries included [Devcontainer](https://code.visualstudio.com/docs/remote/containers) with postgres service\n  Container and local DNS resolvig managed by [Traefik](https://doc.traefik.io/traefik/).\n- Easy fully working Odoo instance by `docker-compose up` with https access.\n- `godoo` CLI wrapper around Odoo. (Most flags can be configured by Environment Variables and are already preconfigured\n  in the Containers. See [.env.sample](./.env.sample))\n- `odoo-bin` is added to PATH and can thus be invoked from every folder.\n- Odoo will run in Proxy_Mode behind a Traefik reverse proxy for easy access on\n  `https://$COMPOSE_PROJECT_NAME.docker.localhost`\n- [Odoo Pylint plugin](https://github.com/OCA/pylint-odoo) preconfigured in vscode\n- Preinstalled vscode Extensions Highlights:\n  - [SQL Tools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) with preconfigured connection for\n    easy Database access in the Sidebar.\n  - [Docker Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) controls\n    container host.\n  - [Odoo Snippets](https://marketplace.visualstudio.com/items?itemName=mstuttgart.odoo-snippets)\n  - [Odoo Developments](https://marketplace.visualstudio.com/items?itemName=scapigliato.vsc-odoo-development) can Grab\n    Odoo Model information from a running Server\n  - [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)\n\n## Usage\n\n1. For Docker on windows: Clone the repo into the WSL2 Filesystem for better IO performance\n2. Have [Traefik](https://github.com/traefik/traefik) Running on `docker.localhost`\n   [Example](https://github.com/joshkreud/traefik_devproxy) \\\n   There must be a Docker network called `traefik` that can reach traefik.\n3. Open Devcontianer:\n   - If you have the Devcontainer CLI: `devcontainer open .`\n   - If not open the workspace in Local Vscode. In the Command pallete search for `Reopen in container`\n4. From **within the container** start Odoo using one of the following commands:\n   - You can enable godoo tab-completion by `godoo --install-completion`\n   - `make` -> Loads Odoo + Workspace Addons\n   - `make bare` -> Loads Odoo with ony `web` installed.\n   - `make enterprise` -> godoo launch with `-i web_enterprise` parameter\n   - `make kill` -> Search for `odoo-bin` processes and kill them\n   - `make reset` -> Drops DB, deletes config file and datafolder\n   - The full init script is available via "`godoo`". (See --help for Options)\n5. Open Odoo `https://$COMPOSE_PROJECT_NAME.docker.localhost`\\\n   For example `COMPOSE_PROJECT_NAME=godoo` --> [https://godoo.docker.localhost](https://godoo.docker.localhost)\n6. Login with `admin:admin`\n7. Profit!\n\n### Access to Odoo and Thirdparty addon Source\n\nYou can access the Odoo source by opening the VsCode workspace [full.code-workspace](full.code-workspace) from within\nthe Container. This will open a [Multi-Root Workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces).\nReally waiting for https://github.com/microsoft/vscode-remote-release/issues/3665 here.\n\n## Reset Devcontainer Data\n\nWhen you screwed up so bad its time to just start Over godoo has you covered:\n\n### Automatic Reset\n\nThere are 3 Options to reset the Dev Env.\n\n1. From **Outside** the Container run `make reset` in the project root to delete docker volumes and restart the\n   container. (Vscode will prompt to reconnect if still open)\n2. From **Outside** the Container run `make reset-hard` in the project root to force rebuild the main Odoo container and\n   then do the same as `make reset`\n3. From **Inside** the Container run `make reset` to drop the DB and delete varlib and the bootstrap flag, which is way\n   quicker than the other options.\n\n### Manual Reset\n\n1. Close vscode\n2. Remove `app` and `db` container from docker.\n3. Remove volumes: `db, odoo_thirdparty, odoo_web, vscode_extensions`\n4. Restart Devcontainer\n\n## Python Debugging\n\n### VsCode Debugging\n\nDebugging doesn\'t reliably work with\n[Odoo Multiprocess](https://www.odoo.com/documentation/14.0/developer/misc/other/cmdline.html#multiprocessing) mode\nenabled. \\\nThe container ships with a Vscode Debug profile, that sets `--workers 0` to allow for Debugging Breakpoints. See [.vscode/launch.json](./.vscode/launch.json)\n\n### Interactive Shell\n\nUse `godoo shell` to enter an interactive shell on the Database.\n\n# Odoo Modules\n\n## Third Party Modules (manifest.yml)\n\nThe `godoo` bootstrap function, will download some modules using git. \\\nWhich Repos to download is specified in `ODOO_MANIFEST.yml` ([Default](./ODOO_MANIFEST.yml)) \\\nNot all of the cloned addons are automatically installed. \\\nInstall them via the Apps Page in Odoo using `godoo rpc modules install` or using `odoo-bin`.\\\nModules downloaded on the Odoo Marketplace can be dropped as a `.zip` archive in [./thirdparty](./thirdparty)\n',
+    'author': 'Joshua Kreuder',
+    'author_email': 'Joshua_Kreuder@outlook.com',
+    'maintainer': 'None',
+    'maintainer_email': 'None',
+    'url': 'None',
+    'package_dir': package_dir,
+    'packages': packages,
+    'package_data': package_data,
+    'install_requires': install_requires,
+    'extras_require': extras_require,
+    'entry_points': entry_points,
+    'python_requires': '>=3.8,<3.11',
+}
+
+
+setup(**setup_kwargs)

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/src/godoo_cli/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.0.4"
+__version__ = "0.1.0"
 from .cli import launch_cli

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/src/godoo_cli/commands/source_get.py

@@ -13,7 +13,7 @@ from ..git import GitUrl, git_ensure_addon_repos, git_ensure_odoo_repo
 from ..helpers import download_file
 from ..helpers.cli import typer_unpacker
 from ..helpers.odoo_files import get_odoo_addons_in_folder
-from ..helpers.repospec import remove_unused_folders
+from ..helpers.odoo_manifest import remove_unused_folders
 
 LOGGER = logging.getLogger(__name__)
 
@@ -69,28 +69,28 @@ def update_odoo_conf_addon_paths(odoo_conf: Path, addon_paths: List[Path]):
 
 @typer_unpacker
 def get_source_file(
-    repospec_yml: Path = typer.Option(
-        "", envvar="ODOO_GITSPEC", help="godoo Repospec path, when downloading odoo source (skip repo_url)"
+    manifest_yml: Path = typer.Option(
+        "", envvar="ODOO_GITSPEC", help="godoo manifest path, when downloading odoo source (skip repo_url)"
     ),
-    repo_url: str = typer.Option("", help="git repo url, for specific repo (skip repospec_yml)"),
-    file_ref: str = typer.Option("", help="When not using repospec. File Branch, Commit, Tag..."),
+    repo_url: str = typer.Option("", help="git repo url, for specific repo (skip manifest_yml)"),
+    file_ref: str = typer.Option("", help="When not using manifest. File Branch, Commit, Tag..."),
     file_path: str = typer.Option(..., help="Relative Filepath in Repository"),
     save_path: Path = typer.Option(..., file_okay=True, dir_okay=False, help="Where to write the file"),
 ):
     """Get Raw file from git remote.
-    Either from the Odoo Repo defined in repospec file or from a custom Git remote.
+    Either from the Odoo Repo defined in manifest file or from a custom Git remote.
     """
 
-    if not repo_url and not repospec_yml:
-        raise ValueError("Need to provide either repospec_yml or repo_url")
-    if repospec_yml and not repo_url:
-        repospec = YAML().load(repospec_yml.resolve())
-        odoo_spec = repospec["odoo"]
+    if not repo_url and not manifest_yml:
+        raise ValueError("Need to provide either manifest_yml or repo_url")
+    if manifest_yml and not repo_url:
+        manifest = YAML().load(manifest_yml.resolve())
+        odoo_spec = manifest["odoo"]
         repo_url = odoo_spec["url"]
         file_ref = odoo_spec.get("commit") or odoo_spec.get("branch")
     if not file_ref:
         raise ValueError(
-            "Need to provide file ref. If you provided a repospec, make sure there is a branch or commit key in the odoo section"
+            "Need to provide file ref. If you provided a manifest, make sure there is a branch or commit key in the odoo section"
         )
     git_url = GitUrl(repo_url)
     file_url = git_url.get_file_raw_url(ref=file_ref, file_path=file_path)
@@ -101,7 +101,7 @@ def get_source_file(
 @typer_unpacker
 def get_source(
     ctx: typer.Context,
-    repospec_yml: Path = typer.Option(
+    manifest_yml: Path = typer.Option(
         ..., envvar="ODOO_GITSPEC", help="Git.yml file, that specified what to download with wich prefix"
     ),
     thirdparty_addon_path: Path = typer.Option(
@@ -132,7 +132,7 @@ def get_source(
     if update_mode in ["all", "odoo"]:
         git_ensure_odoo_repo(
             target_folder=ctx.obj.odoo_main_path,
-            repo_spec_file=repospec_yml,
+            manifest_file=manifest_yml,
             force_fetch=force_fetch,
             add_compare_comment=add_compare_comments,
             download_archive=ctx.obj.source_download_archive,
@@ -141,7 +141,7 @@ def get_source(
     if update_mode in ["all", "thirdparty"]:
         git_repos = git_ensure_addon_repos(
             root_folder=thirdparty_addon_path,
-            git_yml_path=repospec_yml,
+            git_yml_path=manifest_yml,
             generate_yml_compare_comments=add_compare_comments,
             download_archive=ctx.obj.source_download_archive,
         )

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/src/godoo_cli/git/git_odoo.py

@@ -1,7 +1,7 @@
 import logging
 from pathlib import Path
 
-from ..helpers.repospec import yaml_add_compare_commit, yaml_remove_compare_commit, yaml_roundtrip_loader
+from ..helpers.odoo_manifest import yaml_add_compare_commit, yaml_remove_compare_commit, yaml_roundtrip_loader
 from .git_repo import git_ensure_repo
 
 LOGGER = logging.getLogger(__name__)
@@ -9,19 +9,19 @@ LOGGER = logging.getLogger(__name__)
 
 def git_ensure_odoo_repo(
     target_folder: Path,
-    repo_spec_file: Path,
+    manifest_file: Path,
     force_fetch: bool,
     add_compare_comment: bool,
     download_archive: bool,
 ):
     yaml = yaml_roundtrip_loader()
-    git_repos = yaml.load(repo_spec_file.resolve())
+    git_repos = yaml.load(manifest_file.resolve())
     if not git_repos:
-        raise FileNotFoundError(f"Couldnt load yml file from: {str(repo_spec_file)}")
+        raise FileNotFoundError(f"Couldnt load yml file from: {str(manifest_file)}")
 
     odoo_data = git_repos.get("odoo")
     if not odoo_data:
-        raise KeyError(f"Could not find key 'odoo' in {str(repo_spec_file)}")
+        raise KeyError(f"Could not find key 'odoo' in {str(manifest_file)}")
 
     odoo_url = odoo_data["url"]
     odoo_branch = odoo_data.get("branch", "master")
@@ -42,4 +42,4 @@ def git_ensure_odoo_repo(
         single_branch=True,
     )
 
-    yaml.dump(git_repos, repo_spec_file)
+    yaml.dump(git_repos, manifest_file)

{godoo_cli-0.0.4 → godoo_cli-0.1.0}/src/godoo_cli/git/git_odoo_addons.py

@@ -5,7 +5,7 @@ from typing import Dict
 
 from git import Commit
 
-from ..helpers.repospec import update_yml, yaml_roundtrip_loader
+from ..helpers.odoo_manifest import update_yml, yaml_roundtrip_loader
 from .git_repo import git_ensure_repo
 from .git_url import GitUrl
 
@@ -72,7 +72,7 @@ def _git_clone_addon_repos(
         futures = []
         thirdparty_repos = git_repos.get("thirdparty")
         if not thirdparty_repos:
-            LOGGER.info("No Thirdparty Key in Repospec. Skipping...")
+            LOGGER.info("No Thirdparty Key in manifest. Skipping...")
             return
         for prefix, repos in thirdparty_repos.items():
             for repo in repos:

godoo_cli-0.0.4/src/godoo_cli/helpers/repospec.py → godoo_cli-0.1.0/src/godoo_cli/helpers/odoo_manifest.py

@@ -50,7 +50,7 @@ def update_yml(
     thirdparty_repos = repo_yml["thirdparty"]
     odoo_default_branch = repo_yml["odoo"].get("branch")
     if not odoo_default_branch:
-        LOGGER.error("Repospec Odoo Key missing Branch argument.")
+        LOGGER.error("Odoo Key in manifest missing branch argument.")
         return
 
     for prefix in thirdparty_repos:

godoo_cli-0.0.4/setup.py

@@ -1,61 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-package_dir = \
-{'': 'src'}
-
-packages = \
-['godoo_cli',
- 'godoo_cli.commands',
- 'godoo_cli.commands.rpc',
- 'godoo_cli.git',
- 'godoo_cli.helpers']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['gitpython==3.1.27',
- 'godoo-rpc==0.0.3',
- 'openupgradelib==3.3.4',
- 'python-dotenv==0.20.0',
- 'rich==12.6.0',
- 'ruamel-yaml==0.17.21',
- 'typer[all]>=0.7.0,<0.8.0']
-
-extras_require = \
-{'codequality': ['pylint-odoo==8.0.16',
-                 'black==22.10.0',
-                 'isort==5.10.1',
-                 'flake8==5.0.4'],
- 'devcontainer': ['ipdb==0.13.9',
-                  'debugpy==1.6.0',
-                  'pre-commit==2.20.0',
-                  'watchdog==2.1.7',
-                  'py-spy==0.3.11',
-                  'rope==0.23.0']}
-
-entry_points = \
-{'console_scripts': ['godoo = godoo_cli:launch_cli']}
-
-setup_kwargs = {
-    'name': 'godoo-cli',
-    'version': '0.0.4',
-    'description': 'Wrapper around Odoo-Bin with some convinience RPC functions.',
-    'long_description': '# gOdoo Dev Environment\n\n![OdooLogo](https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/odoo_logo.png)\n![ComposeLogo](https://raw.githubusercontent.com/docker/compose/v2/logo.png)\n\n**gOdoo** is short for **go Odoo**. \\\nIt is a [Vscode Devcontainer](https://code.visualstudio.com/docs/remote/containers) Environment for [Odoo](https://odoo.com/)\nwith Python CLI `godoo` convenience wrapper around `odoo-bin`.\n\nThis repository is the base source for the Python package [godoo-cli](https://pypi.org/project/godoo-cli/) and serves as\nan all batteries included development environment.\n\nMade Possible by: [WEMPE Elektronic GmbH](https://wetech.de)\n\n# gOdoo-cli\n\nPython package that provides `godoo` command line interface around `odoo-bin`.\n\nIt\'s build with [Typer](https://github.com/tiangolo/typer) to provide some convenience Wrappers for Odoo development and\nDeployment.\n\nMost flags can be configured by Env variables. \\\nUse `godoo --help` to find out more.\n\n# Docker\n\nThis workspace also contains Docker and Docker-Compose files. \\\n\nThey are used to provide either easy Odoo instances where the source is pulled according to\n[odoo_repospec.yml](./odoo_repospec.yml), or as a all batteries included devcontainer for VScode.\n\n## Requirements\n\n- [Docker Compose](https://github.com/docker/compose)\n- [Traefik](https://doc.traefik.io/traefik/) container running with docker provider and "traefik" named docker network.\n  Example: [Traefik Devproxy](https://github.com/joshkreud/traefik_devproxy)\n- SSH Agent running. (check `echo $SSH_AUTH_SOCK`)\\\n  This gets passed trough in the Buildprocess to clone Thirdparty repos.\n\n## Just wanna have a quick and easy Odoo Instance?\n\n```bash\ngit clone https://github.com/OpenJKSoftware/gOdoo\ncd godoo\n. scripts/container_requirements.sh # Check Requirements\ndocker-compose build\ndocker-compose up\n# wait......\n# wait a bit mode ...\n# just a little bit longer ..\n# There we go.\n# Odoo should be reachable on \'https://godoo.docker.localhost\' assuming you didn\'t change .env TRAEFIK_HOST_RULE or COMPOSE_PROJECT_NAME\n```\n\n# Devcontainer\n\n## Features\n\n- All batteries included [Devcontainer](https://code.visualstudio.com/docs/remote/containers) with postgres service\n  Container and local DNS resolvig managed by [Traefik](https://doc.traefik.io/traefik/).\n- Easy fully working Odoo instance by `docker-compose up` with https access.\n- `godoo` CLI wrapper around Odoo. (Most flags can be configured by Environment Variables and are already preconfigured\n  in the Containers. See [.env.sample](./.env.sample))\n- `odoo-bin` is added to PATH and can thus be invoked from every folder.\n- Odoo will run in Proxy_Mode behind a Traefik reverse proxy for easy access on\n  `https://$COMPOSE_PROJECT_NAME.docker.localhost`\n- [Odoo Pylint plugin](https://github.com/OCA/pylint-odoo) preconfigured in vscode\n- Preinstalled vscode Extensions Highlights:\n  - [SQL Tools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) with preconfigured connection for\n    easy Database access in the Sidebar.\n  - [Docker Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) controls\n    container host.\n  - [Odoo Snippets](https://marketplace.visualstudio.com/items?itemName=mstuttgart.odoo-snippets)\n  - [Odoo Developments](https://marketplace.visualstudio.com/items?itemName=scapigliato.vsc-odoo-development) can Grab\n    Odoo Model information from a running Server\n  - [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)\n\n## Usage\n\n1. For Docker on windows: Clone the repo into the WSL2 Filesystem for better IO performance\n2. Have [Traefik](https://github.com/traefik/traefik) Running on `docker.localhost`\n   [Example](https://github.com/joshkreud/traefik_devproxy) \\\n   There must be a Docker network called `traefik` that can reach traefik.\n3. Open Devcontianer:\n   - If you have the Devcontainer CLI: `devcontainer open .`\n   - If not open the workspace in Local Vscode. In the Command pallete search for `Reopen in container`\n4. From **within the container** start Odoo using one of the following commands:\n   - `make` -> Loads Odoo + Workspace Addons\n   - `make bare` -> Loads Odoo with ony `web` installed.\n   - `make enterprise` -> godoo launch with install script for web_enterprise\n   - The full init script is available via "`godoo`". (See --help for Options)\n5. Open Odoo `https://$COMPOSE_PROJECT_NAME.docker.localhost`\\\n   For example `COMPOSE_PROJECT_NAME=godoo` --> [https://godoo.docker.localhost](https://godoo.docker.localhost)\n6. Login with `admin:admin`\n7. Profit!\n\n### Access to Odoo and Thirdparty addon Source\n\nYou can access the Odoo source by opening the VsCode workspace [full.code-workspace](full.code-workspace) from within\nthe Container. This will open a [Multi-Root Workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces).\nReally waiting for https://github.com/microsoft/vscode-remote-release/issues/3665 here.\n\n## Reset Devcontainer Data\n\nWhen you screwed up so bad its time to just start Over godoo has you covered:\n\n### Automatic Reset\n\nThere are 3 Options to reset the Dev Env.\n\n1. From **Outside** the Container run `make reset` in the project root to delete docker volumes and restart the\n   container. (Vscode will prompt to reconnect if still open)\n2. From **Outside** the Container run `make reset-hard` in the project root to force rebuild the main Odoo container and\n   then do the same as `make reset`\n3. From **Inside** the Container run `make reset` to drop the DB and delete varlib and the bootstrap flag, which is way\n   quicker than the other options.\n\n### Manual Reset\n\n1. Close vscode\n2. Remove `app` and `db` container from docker.\n3. Remove volumes: `db, odoo_thirdparty, odoo_web, vscode_extensions`\n4. Restart Devcontainer\n\n## Python Debugging\n\n### VsCode Debugging\n\nDebugging doesn\'t reliably work with\n[Odoo Multiprocess](https://www.odoo.com/documentation/14.0/developer/misc/other/cmdline.html#multiprocessing) mode\nenabled. \\\nThe container ships with a Vscode Debug profile, that sets `--workers 0` to allow for Debugging Breakpoints. See [.vscode/launch.json](./.vscode/launch.json)\n\n### Interactive Shell\n\nUse `godoo shell` to enter an interactive shell on the Database.\n\n# Odoo Modules\n\n## Third Party Modules (repospec.yml)\n\nThe `godoo` bootstrap function, will download some modules using git. \\\nWhich Repos to download is specified in `odoo_repospec.yml` ([Default](./odoo_repospec.yml)) \\\nNot all of the cloned addons are automatically installed. \\\nInstall them via the Apps Page in Odoo using `godoo rpc modules install` or using `odoo-bin`.\\\nModules downloaded on the Odoo Marketplace can be dropped as a `.zip` archive in [./thirdparty](./thirdparty)\n',
-    'author': 'Joshua Kreuder',
-    'author_email': 'Joshua_Kreuder@outlook.com',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'None',
-    'package_dir': package_dir,
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'extras_require': extras_require,
-    'entry_points': entry_points,
-    'python_requires': '>=3.8,<3.11',
-}
-
-
-setup(**setup_kwargs)