gOdoo-cli 0.7.0__py3-none-any.whl

godoo_cli-0.7.0.dist-info/LICENSE

@@ -0,0 +1,165 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

godoo_cli-0.7.0.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.1
+Name: gOdoo-cli
+Version: 0.7.0
+Summary: Wrapper around Odoo-Bin with some convinience RPC functions.
+Home-page: https://github.com/OpenJKSoftware/gOdoo
+License: LGPL-3
+Keywords: odoo,godoo,devcontainer
+Author: Joshua Kreuder
+Author-email: Joshua_Kreuder@outlook.com
+Requires-Python: >=3.8.1,<3.12
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: codequality
+Provides-Extra: devcontainer
+Requires-Dist: black (>=22.10.0,<23.0.0) ; extra == "codequality"
+Requires-Dist: debugpy (>=1.6.0,<2.0.0) ; extra == "devcontainer"
+Requires-Dist: flake8 (>=5.0.4,<6.0.0) ; extra == "codequality"
+Requires-Dist: gitpython (>=3.1.27,<4.0.0)
+Requires-Dist: godoo-rpc (>=0.1.1,<0.2.0)
+Requires-Dist: inotify (>=0.2.10,<0.3.0) ; extra == "devcontainer"
+Requires-Dist: ipdb (>=0.13.9,<0.14.0) ; extra == "devcontainer"
+Requires-Dist: isort (>=5.10.1,<6.0.0) ; extra == "codequality"
+Requires-Dist: mock (>=4.0.3,<5.0.0) ; extra == "devcontainer"
+Requires-Dist: openupgradelib (>=3.3.4,<4.0.0)
+Requires-Dist: passlib (>=1.7.3,<2.0.0)
+Requires-Dist: psycopg2 (>=2.8.6,<3.0.0)
+Requires-Dist: py-spy (>=0.3.11,<0.4.0) ; extra == "devcontainer"
+Requires-Dist: pydevd-odoo (>=1.2.1,<2.0.0) ; extra == "devcontainer"
+Requires-Dist: pylint-odoo (>=8.0.16,<9.0.0) ; extra == "codequality"
+Requires-Dist: pytest (>=7.2.1,<8.0.0) ; extra == "codequality"
+Requires-Dist: pytest-cov (>=4.0.0,<5.0.0) ; extra == "codequality"
+Requires-Dist: python-dotenv (>=0.20.0,<0.21.0)
+Requires-Dist: rope (>=0.23.0,<0.24.0) ; extra == "devcontainer"
+Requires-Dist: ruamel-yaml (>=0.17.21,<0.18.0)
+Requires-Dist: typer (>=0.9.0,<0.10.0)
+Requires-Dist: typer-common-functions (>=0.0.5,<0.0.6)
+Requires-Dist: watchdog (>=2.1.7,<3.0.0) ; extra == "devcontainer"
+Project-URL: Repository, https://github.com/OpenJKSoftware/gOdoo
+Description-Content-Type: text/markdown
+
+# gOdoo Dev Environment
+
+![OdooLogo](https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/odoo_logo.png)
+![ComposeLogo](https://raw.githubusercontent.com/docker/compose/v2/logo.png)
+
+[<img src="https://raw.githubusercontent.com/OpenJKSoftware/gOdoo/main/assets/godoo-main-cli.png" width="1000"/>](image.png)
+
+**gOdoo** is short for **go Odoo**. \
+It is a [Vscode Devcontainer](https://code.visualstudio.com/docs/remote/containers) Environment for [Odoo](https://odoo.com/)
+with Python CLI `godoo` convenience wrapper around `odoo-bin`.
+
+This repository is the base source for the Python package [godoo-cli](https://pypi.org/project/godoo-cli/) and serves as
+an all batteries included development environment.
+
+This is the source repository for `gOdoo`. If you want to use `gOdoo` please refer to [./docker/Dockerfile](./docker/Dockerfile) and modify it to install godoo using Pip.
+
+Made Possible by: [WEMPE Elektronic GmbH](https://wetech.de)
+
+# gOdoo-cli
+
+Python package that provides `godoo` command line interface around `odoo-bin`.
+
+It's build with [Typer](https://github.com/tiangolo/typer) to provide some convenience Wrappers for Odoo development and
+Deployment.
+
+Most flags can be configured by Env variables. \
+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_MANIFEST.yml](odoo_manifest.yml), or as a all batteries included devcontainer for VScode.
+
+## Requirements
+
+- [Docker Compose](https://github.com/docker/compose)
+- [Traefik](https://doc.traefik.io/traefik/) container running with docker provider and "traefik" named docker network.
+  Example: [Traefik Devproxy](https://github.com/joshkreud/traefik_devproxy)
+- SSH Agent running. (check `echo $SSH_AUTH_SOCK`)\
+  This gets passed trough in the Buildprocess to clone Thirdparty repos (Optional).
+
+## Just wanna have a quick and easy Odoo Instance?
+
+```bash
+git clone https://github.com/OpenJKSoftware/gOdoo
+cd godoo
+. scripts/container_requirements.sh # Check Requirements
+docker-compose build
+docker-compose up
+# wait......
+# wait a bit mode ...
+# just a little bit longer ..
+# There we go.
+# Odoo should be reachable on 'https://godoo.docker.localhost' assuming you didn't change .env TRAEFIK_HOST_RULE or COMPOSE_PROJECT_NAME
+```
+
+# Devcontainer
+
+## Features
+
+- All batteries included [Devcontainer](https://code.visualstudio.com/docs/remote/containers) with postgres service
+  Container and local DNS resolvig managed by [Traefik](https://doc.traefik.io/traefik/).
+- Easy fully working Odoo instance by `docker-compose up` with https access.
+- `godoo` CLI wrapper around Odoo. (Most flags can be configured by Environment Variables and are already preconfigured
+  in the Containers. See [.env.sample](./.env.sample))
+- Cups Container, that provides a CUPS Printserver
+- `odoo-bin` is added to PATH and can thus be invoked from every folder.
+- Odoo will run in Proxy_Mode behind a Traefik reverse proxy for easy access on
+  `https://$COMPOSE_PROJECT_NAME.docker.localhost`
+- [Odoo Pylint plugin](https://github.com/OCA/pylint-odoo) preconfigured in vscode
+- Preinstalled vscode Extensions Highlights:
+  - [SQL Tools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) with preconfigured connection for
+    easy Database access in the Sidebar.
+  - [Docker Extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) controls
+    container host.
+  - [Odoo Snippets](https://marketplace.visualstudio.com/items?itemName=mstuttgart.odoo-snippets)
+  - [Odoo Developments](https://marketplace.visualstudio.com/items?itemName=scapigliato.vsc-odoo-development) can Grab
+    Odoo Model information from a running Server
+  - [Todo Tree](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree)
+
+## Usage
+
+1. For Docker on windows: Clone the repo into the WSL2 Filesystem for better IO performance
+2. Have [Traefik](https://github.com/traefik/traefik) Running on `docker.localhost`
+   [Example](https://github.com/joshkreud/traefik_devproxy) \
+   There must be a Docker network called `traefik` that can reach traefik.
+3. Open Devcontianer:
+   - 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 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)
+6. Login with `admin:admin`
+7. Profit!
+
+### Access to Odoo and Thirdparty addon Source
+
+You can access the Odoo source by opening the VsCode workspace [full.code-workspace](full.code-workspace) from within
+the Container. This will open a [Multi-Root Workspace](https://code.visualstudio.com/docs/editor/multi-root-workspaces).
+Really waiting for https://github.com/microsoft/vscode-remote-release/issues/3665 here.
+
+## Reset Devcontainer Data
+
+When you screwed up so bad its time to just start Over godoo has you covered:
+
+### Automatic Reset
+
+There are 3 Options to reset the Dev Env.
+
+1. From **Outside** the Container run `make reset` in the project root to delete docker volumes and restart the
+   container. (Vscode will prompt to reconnect if still open)
+2. From **Outside** the Container run `make reset-hard` in the project root to force rebuild the main Odoo container and
+   then do the same as `make reset`
+3. From **Inside** the Container run `make reset` to drop the DB and delete filestore and config file, which is way
+   quicker than the other options.
+
+### Manual Reset
+
+1. Close vscode
+2. Remove `app` and `db` container from docker.
+3. Remove volumes: `db, odoo_thirdparty, odoo_web, vscode_extensions`
+4. Restart Devcontainer
+
+## Python Debugging
+
+### VsCode Debugging
+
+Debugging doesn't reliably work with
+[Odoo Multiprocess](https://www.odoo.com/documentation/14.0/developer/misc/other/cmdline.html#multiprocessing) mode
+enabled. \
+The container ships with a Vscode Debug profile, that sets `--workers 0` to allow for Debugging Breakpoints. See [.vscode/launch.json](./.vscode/launch.json)
+
+### Interactive Shell
+
+Use `godoo shell` to enter an interactive shell on the Database.
+
+# Odoo Modules
+
+## Third Party Modules (manifest.yml)
+
+The `godoo` bootstrap function, will download some modules using git. \
+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.7.0.dist-info/RECORD

@@ -0,0 +1,45 @@
+godoo_cli/__init__.py,sha256=R6S8ZPpnZrXJxUXTI1mm-_XQD4Sl_7_w3nmOPgsW00k,61
+godoo_cli/__main__.py,sha256=vabFnEJgLssqYOmHzo8rZx_uDdsSc3aQnD3bYXGjBNc,88
+godoo_cli/cli.py,sha256=MCko5-vEFNONE2sc01mObcb2vKrQEcMUPOL-oZR5Vkw,2120
+godoo_cli/cli_common.py,sha256=1PQauZ7LV8gAW_bV6ocdEIXIwhbDS-GCi1BV7RqYPfU,5397
+godoo_cli/commands/__init__.py,sha256=VZiyWcxArU1JiSPlBhZXY61rqYvyhKNOSsaJdiyEJEg,328
+godoo_cli/commands/backup/__init__.py,sha256=pJcUr-OHADdADD-PClT6vEEhrTlvTWILTyWbx69JGt8,32
+godoo_cli/commands/backup/cli.py,sha256=n8_KO0CWqZMHcioAFATgQh1ekLc-WNseh-oozf3yndU,372
+godoo_cli/commands/backup/load.py,sha256=sRYy0hcJB17tIemMxscMq4olUuOSuaj2O-8VDQ04VOQ,3062
+godoo_cli/commands/backup/pull.py,sha256=Nk-i0HSAbHJjSFGMhn1Py3sy1IFwQCuJYbcpYjTg4HQ,5089
+godoo_cli/commands/backup/util.py,sha256=r3fZKWL6UjHNkshBDlnh8Fc_1biM_TdyCPi649rUU_8,1278
+godoo_cli/commands/bootstrap.py,sha256=JA28HXV6nMtJZHximJTT0njpfQ7Suu0up3mcsxG6iFs,5811
+godoo_cli/commands/config.py,sha256=I2LvMraLWIQN_nsYlcxy_QQz9o0RSssnukZ6fry6VBw,1173
+godoo_cli/commands/db/__init__.py,sha256=MU0q08_oaP0_qxJYhenfYpEXjSkSRCoLPX3pCgvTuUE,28
+godoo_cli/commands/db/cli.py,sha256=VrVKo-rBKyaCBE7JGHCFNuCwrfb9TtnzRguOWmcwm1g,386
+godoo_cli/commands/db/connection.py,sha256=lnxpHCE_dDExpFdIzKfkbTI4twnhq-honqxS4yzJxmI,2718
+godoo_cli/commands/db/passwords.py,sha256=G84ajoJYXz-8yvRILhpSUheS79jPsL32M4ooDOjxhgI,1400
+godoo_cli/commands/db/query.py,sha256=leBIB5sBKJ3a0q8kIReJOJz4V-Il2FyCvOrzuws9D7c,1069
+godoo_cli/commands/launch.py,sha256=pCcQPS9nGTPxgJd2P81vil6KkgGpwNnyInJBbLPTU8o,10676
+godoo_cli/commands/rpc/__init__.py,sha256=yFdMBrNgS2OGheOD4voUOHUXW6XZyL6T11kN0CvOnNI,177
+godoo_cli/commands/rpc/cli.py,sha256=gxwtjB3bB9LyU6uQ4X03ROb2xxjAwcDBtkwVtjQj5Ag,897
+godoo_cli/commands/rpc/config_parameters.py,sha256=KnCtHuWsUyWGR4lzJrvBbhTzF43ENJkpoptcP7UHWqM,1484
+godoo_cli/commands/rpc/importer.py,sha256=AYeMnDr5bZPMZ75xI4aclM98NL8woTq096DBx5y5y7I,2278
+godoo_cli/commands/rpc/modules.py,sha256=DSZi_0x2UmpMi1-gIPqKOlOx54WFgx1xutUiqN_lIRo,4828
+godoo_cli/commands/rpc/translations.py,sha256=xFXqcBUE1CKNjKi4K6m-NIIcyfNbNuiQvyWhmsGJ6FQ,4000
+godoo_cli/commands/shell.py,sha256=ySpH-fs-U6SBV_J2fkcAPmNkUOWFsFxOdXymO-asi0s,1619
+godoo_cli/commands/source_get.py,sha256=183i5z5NDgAYZ86cTOUvwPlard-DBz1nUNYLuPzX_zE,10727
+godoo_cli/commands/test.py,sha256=C25GbfjmhvHHj5JCBDcyXviLFnGEkQrutLMUh0XRd-g,4572
+godoo_cli/git/__init__.py,sha256=gIn8mWrsacA671ZcBVzY-hnJKrsF3v4gEqgQGFTH2t0,161
+godoo_cli/git/git_odoo.py,sha256=GACsS478mvTtRX7S9igE_bGBkADQH8fK1YJvQjMmcOI,2688
+godoo_cli/git/git_odoo_addons.py,sha256=CRcclkFy1amtQ5q2JxioEfdTLpiQYBcQF7RAmwwRNSI,3296
+godoo_cli/git/git_repo.py,sha256=29rc8fFBcuV8-jF_LlsdRqk2gKpRxztFtRqyfzNU4R4,6460
+godoo_cli/git/git_url.py,sha256=5sDx2xnTXPLhCY6w2yRnUscMtCVObC281v0t6xzGUBA,4585
+godoo_cli/git/zip_download.py,sha256=tbt5g4Z-1zxcQx9Hn07xWX0IomhyYeane8B7evm3lJ8,1575
+godoo_cli/helpers/__init__.py,sha256=t4VzYapYAMxzwgv6kQu8wvaLnkXFvPNyO15LnRZqzkE,49
+godoo_cli/helpers/bootstrap.py,sha256=yeJpsPkUSZA-4OF4VZKNfHrXKW5bFZ3jtvjL7g_WkCE,2201
+godoo_cli/helpers/cli.py,sha256=iPpxtwItn6xifJOWDfDr_QYR-KrnK-cSqIhHrJsQVBQ,386
+godoo_cli/helpers/odoo_files.py,sha256=rv3ueFyGrwoTKZPqw6TI7seSpgqsaLxO0Y718te0Lwg,8872
+godoo_cli/helpers/odoo_manifest.py,sha256=8_kI22kF80raiF-ttRDRwudwAfaem7mcAks_BJi_R5E,3277
+godoo_cli/helpers/system.py,sha256=qidaHdfGrmrJpZ7GHKh07uUqwWjHtlnnK0xsoQfzFYc,4793
+godoo_cli/version.py,sha256=RaANGbRu5e-vehwXI1-Qe2ggPPfs1TQaZj072JdbLk4,22
+godoo_cli-0.7.0.dist-info/LICENSE,sha256=ZVetxLwdWSMuJ1Z6GF3XDPLsyjFUAYsL5h6inPnoFOI,7633
+godoo_cli-0.7.0.dist-info/METADATA,sha256=QlLo-EBkjmAq9o5VWrxxJeBm5j6vJ5kQWAl6G-WWM0g,9359
+godoo_cli-0.7.0.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+godoo_cli-0.7.0.dist-info/entry_points.txt,sha256=jXhSyRfKYyScnprAvzGkRdqaZCP5EPJahfzs1NfRzzU,46
+godoo_cli-0.7.0.dist-info/RECORD,,

godoo_cli-0.7.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.7.0
+Root-Is-Purelib: true
+Tag: py3-none-any

godoo_cli-0.7.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+godoo=godoo_cli:launch_cli
+