odooflow-cli 0.1.0__tar.gz

odooflow_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mohammad Hamdan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

odooflow_cli-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: odooflow-cli
+Version: 0.1.0
+Summary: OdooFlow CLI - streamline your Odoo development workflow
+Author: Mohammad A. Hamdan
+License: MIT
+Project-URL: Homepage, https://github.com/anomalyco/odooflow
+Project-URL: Repository, https://github.com/anomalyco/odooflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]
+Requires-Dist: rich
+Requires-Dist: GitPython>=3.1.44
+Requires-Dist: requests>=2.32.3
+Requires-Dist: paramiko>=3.5.1
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: bcrypt>=4.3.0
+Requires-Dist: cryptography>=45.0.3
+Requires-Dist: PyNaCl>=1.5.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: twine>=6.1.0; extra == "dev"
+Dynamic: license-file
+
+# 🌀 Odooflow CLI
+
+**Odooflow CLI** is a command-line interface tool designed to streamline the development workflow for Odoo projects. It helps clone Odoo modules (and their dependencies), handles GitLab lookups, and provides options for deep recursive cloning.
+
+## 🚀 Features
+
+- Clone an Odoo module by Git URL
+- Recursively resolve and clone all dependencies
+- Smart skip of Odoo core modules
+- Branch selection for cloning
+- Helpful and colorful CLI output
+- Built using [Typer](https://typer.tiangolo.com/) and Python 3.9+
+
+---
+
+## 📦 Installation
+
+```bash
+git clone https://github.com/YOUR_USERNAME/odooflow-cli.git
+cd odooflow-cli
+pip install .
+```
+
+Or install directly from source for development:
+
+```bash
+pip install -e .
+```
+
+---
+
+## 🛠️ Usage
+
+Once installed, you can use the CLI by running:
+
+```bash
+odooflow --help
+```
+
+### Available Commands:
+
+- **`init`**: Initialize the Odoo module environment file and sync metadata with manifest
+- **`sync-env`**: Sync the environment file from manifest
+- **`config`**: Update or show OdooFlow CLI configuration
+- **`clone`**: Clone a module and its dependencies from a git repository
+- **`remote`**: Manage remote connections for Git and deployment server
+- **`ssh-keygen`**: Generate a secure SSH key pair
+- **`push`**: Push the current Git branch and upload the project to the test server
+
+### Clone Command Options:
+
+| Flag        | Description                              |
+|-------------|------------------------------------------|
+| `--url`     | Full HTTP URL of the module repo         |
+| `--branch`  | (Optional) Git branch to clone from      |
+| `--deep`    | Recursively clone all dependencies       |
+
+### 🔍 Examples:
+
+Clone a single module:
+
+```bash
+odooflow clone --url https://gitlab.com/mygroup/my_odoo_module.git
+```
+
+Clone with specific branch:
+
+```bash
+odooflow clone --url https://gitlab.com/mygroup/my_odoo_module.git --branch 17.0
+```
+
+Clone deeply with dependencies:
+
+```bash
+odooflow clone --url https://gitlab.com/mygroup/my_odoo_module.git --deep
+```
+
+---
+
+## 📁 Project Structure
+
+```
+odooflow/
+├── odooflow/
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── config_manager.py
+│   ├── commands/
+│   │   ├── __init__.py
+│   │   ├── clone_module.py
+│   │   ├── config.py
+│   │   ├── init_module_env.py
+│   │   ├── keygen.py
+│   │   ├── push.py
+│   │   ├── remote.py
+│   │   └── sync_env.py
+│   └── utils/
+│       ├── env.py
+│       └── ssh.py
+├── tests/
+├── README.md
+├── requirements.txt
+├── setup.py
+└── LICENSE
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request with any improvements, bug fixes, or new features.
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature/your-feature`)
+3. Commit your changes (`git commit -am 'Add new feature'`)
+4. Push to the branch (`git push origin feature/your-feature`)
+5. Open a Pull Request
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## WISH-LIST:
+
+Move this CLI into fully-integrated Odoo environment, using Odoo, users can create issues, add the amount of details, then sync these issues with Odooflow.
+
+We can do integration with any code agent to help developers to achieve these issues 
+
+same thing for pipelines, I think it will be amazing if developers can build pipelines using Odoo, then apply the same pipelines using Odooflow.
+
+I have many things in my head, I will back soon to this project.
+
+## 👨‍💻 Author
+
+Made with ❤️ by Mohammad A. Hamdan
+
+---

odooflow_cli-0.1.0/README.md

@@ -0,0 +1,141 @@
+# 🌀 Odooflow CLI
+
+**Odooflow CLI** is a command-line interface tool designed to streamline the development workflow for Odoo projects. It helps clone Odoo modules (and their dependencies), handles GitLab lookups, and provides options for deep recursive cloning.
+
+## 🚀 Features
+
+- Clone an Odoo module by Git URL
+- Recursively resolve and clone all dependencies
+- Smart skip of Odoo core modules
+- Branch selection for cloning
+- Helpful and colorful CLI output
+- Built using [Typer](https://typer.tiangolo.com/) and Python 3.9+
+
+---
+
+## 📦 Installation
+
+```bash
+git clone https://github.com/YOUR_USERNAME/odooflow-cli.git
+cd odooflow-cli
+pip install .
+```
+
+Or install directly from source for development:
+
+```bash
+pip install -e .
+```
+
+---
+
+## 🛠️ Usage
+
+Once installed, you can use the CLI by running:
+
+```bash
+odooflow --help
+```
+
+### Available Commands:
+
+- **`init`**: Initialize the Odoo module environment file and sync metadata with manifest
+- **`sync-env`**: Sync the environment file from manifest
+- **`config`**: Update or show OdooFlow CLI configuration
+- **`clone`**: Clone a module and its dependencies from a git repository
+- **`remote`**: Manage remote connections for Git and deployment server
+- **`ssh-keygen`**: Generate a secure SSH key pair
+- **`push`**: Push the current Git branch and upload the project to the test server
+
+### Clone Command Options:
+
+| Flag        | Description                              |
+|-------------|------------------------------------------|
+| `--url`     | Full HTTP URL of the module repo         |
+| `--branch`  | (Optional) Git branch to clone from      |
+| `--deep`    | Recursively clone all dependencies       |
+
+### 🔍 Examples:
+
+Clone a single module:
+
+```bash
+odooflow clone --url https://gitlab.com/mygroup/my_odoo_module.git
+```
+
+Clone with specific branch:
+
+```bash
+odooflow clone --url https://gitlab.com/mygroup/my_odoo_module.git --branch 17.0
+```
+
+Clone deeply with dependencies:
+
+```bash
+odooflow clone --url https://gitlab.com/mygroup/my_odoo_module.git --deep
+```
+
+---
+
+## 📁 Project Structure
+
+```
+odooflow/
+├── odooflow/
+│   ├── __init__.py
+│   ├── cli.py
+│   ├── config_manager.py
+│   ├── commands/
+│   │   ├── __init__.py
+│   │   ├── clone_module.py
+│   │   ├── config.py
+│   │   ├── init_module_env.py
+│   │   ├── keygen.py
+│   │   ├── push.py
+│   │   ├── remote.py
+│   │   └── sync_env.py
+│   └── utils/
+│       ├── env.py
+│       └── ssh.py
+├── tests/
+├── README.md
+├── requirements.txt
+├── setup.py
+└── LICENSE
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request with any improvements, bug fixes, or new features.
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature/your-feature`)
+3. Commit your changes (`git commit -am 'Add new feature'`)
+4. Push to the branch (`git push origin feature/your-feature`)
+5. Open a Pull Request
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## WISH-LIST:
+
+Move this CLI into fully-integrated Odoo environment, using Odoo, users can create issues, add the amount of details, then sync these issues with Odooflow.
+
+We can do integration with any code agent to help developers to achieve these issues 
+
+same thing for pipelines, I think it will be amazing if developers can build pipelines using Odoo, then apply the same pipelines using Odooflow.
+
+I have many things in my head, I will back soon to this project.
+
+## 👨‍💻 Author
+
+Made with ❤️ by Mohammad A. Hamdan
+
+---

odooflow_cli-0.1.0/odooflow/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

odooflow_cli-0.1.0/odooflow/cli.py

@@ -0,0 +1,105 @@
+import typer
+from typing import List, Optional
+
+from odooflow.commands.init_module_env import init_module_env
+from odooflow.commands.sync_env import sync_env as sync_env_command
+from odooflow.commands.config import config as config_command
+from odooflow.commands.clone_module import clone_module_command
+from odooflow.commands.remote import remote as remote_command
+from odooflow.commands.keygen import generate_ssh_key as keygen_command
+from odooflow.commands.push import push_command
+
+app = typer.Typer(help="OdooFlow CLI — streamline your Odoo development workflow.")
+
+@app.command(name="init")
+def init_manifest(
+    author: Optional[str] = typer.Option(None, help="Author name"),
+    website : Optional[str] = typer.Option(None, help="Website"),
+    odoo_version: Optional[str] = typer.Option(None, help="Odoo version"),
+    license_name: Optional[str] = typer.Option(None, help="License"),
+):
+    """
+    Initialize the Odoo module environment file and sync metadata with manifest.
+    """
+    init_module_env(author=author, odoo_version=odoo_version, license_name=license_name, website=website)
+
+@app.command(name="sync-env")
+def sync_env(
+    keys: Optional[str] = typer.Option(None, "--keys", help="Comma-separated keys to sync from manifest to env file.")
+):
+    """
+    Sync the environment file (.odooflow.env.json) from manifest.
+    """
+    sync_env_command(keys)
+
+@app.command("config", help="Update configuration")
+def config(
+    env_file: Optional[str] = typer.Option(None, help="Set custom env file name"),
+    manifest_file: Optional[str] = typer.Option(None, help="Set custom manifest file name"),
+    access_token : Optional[str] = typer.Option(None, help="Set Git access token"),
+    add_core_module: Optional[str] = typer.Option(None, "--add-core-module", help="Comma-separated list of core modules to add"),
+    sync_keys: Optional[str] = typer.Option(None, help="Set default keys to sync from manifest to .env (comma-separated)"),
+    show: Optional[bool] = typer.Option(False, "--show", help="Show current config")
+):
+    """
+    Update or show OdooFlow CLI configuration (.odooflowrc)
+    """
+    config_command(env_file, manifest_file, access_token, add_core_module, sync_keys,show)
+
+
+@app.command("clone")
+def clone_command(
+    repo_url: str = typer.Argument(..., help="HTTP URL of the module repository."),
+    branch: Optional[str] = typer.Option(None, "--branch", '-b', help="Branch to clone"),
+    depth: int = typer.Option(1, "--depth", "-d", help="Max dependency depth to clone. 1 clones only the target module, 2 clones target + immediate dependencies, etc.")
+):
+    """
+    Clone a module and its dependencies from a git repository.
+    """
+    clone_module_command(repo_url, branch, depth)
+
+
+@app.command()
+def remote(
+    add_repo: Optional[str] = typer.Option(None, help="Add Git remote URL"),
+    branch: Optional[str] = typer.Option(None, help="Target Git branch (defaults to current)"),
+    server_json: Optional[str] = typer.Option(None, help="Server config as JSON: '{\"host\": \"127.0.0.1\", \"port\": 22}'")
+):
+    """
+    Manage remote connections for Git and deployment server.
+    """
+    remote_command(
+        add_repo=add_repo,
+        server_json=server_json, 
+        branch=branch
+    )
+
+@app.command("ssh-keygen")
+def generate_ssh_key(
+    key_name: str = typer.Option("odooflow_rsa", help="Name of the SSH key file to generate (without extension)."),
+    output_dir: Optional[str] = typer.Option(None, help="Directory to save the SSH key. Defaults to ~/.ssh"),
+    overwrite: bool = typer.Option(False, help="Overwrite existing key files if they exist."),
+):
+    """
+    Generate a secure SSH key pair.
+    """
+    keygen_command(key_name=key_name, output_dir=output_dir, overwrite=overwrite)
+
+
+@app.command()
+def push(
+    remote_only: bool = typer.Option(False, "--remote-only", help="Skip Git push and only upload to server"),
+    exec_cmd: Optional[str] = typer.Option(None, "--exec", help="Custom shell command to execute on the server after pushing"),
+):
+    """
+    Push the current Git branch and upload the project to the test server.
+    """
+    push_command(remote_only=remote_only, exec_cmd=exec_cmd)
+
+
+
+def main():
+    app()
+
+if __name__ == "__main__":
+    main()

odooflow_cli-0.1.0/odooflow/commands/clone_module.py

@@ -0,0 +1,160 @@
+import ast
+import typer
+import requests
+import threading
+
+from typing import Optional
+from concurrent.futures import ThreadPoolExecutor
+
+from urllib.parse import urlparse, urlunparse
+from git import Repo, GitCommandError
+from pathlib import Path
+
+from odooflow.config_manager import get_access_token, get_core_modules_from_config, load_config
+
+
+def get_project_url_from_gitlab(module_name: str, base_url: Optional[str] = None) -> Optional[str]:
+    """
+    Search GitLab for a project by name and return its HTTPS URL.
+    """
+    if base_url is None:
+        config = load_config()
+        base_url = config.get("gitlab_url", "https://gitlab.ebtech-solution.com")
+
+    api_url = f"{base_url}/api/v4/projects"
+    params = {"search": module_name, "simple": "true", "per_page": 100, "access_token": get_access_token()}
+    headers = {"Accept": "application/json"}
+
+    try:
+        typer.secho(f"🔍 Searching GitLab for module: {module_name}", fg="cyan")
+        response = requests.get(api_url, headers=headers, params=params)
+        response.raise_for_status()
+
+        for project in response.json():
+            if project["name"] == module_name or project["path"] == module_name:
+                typer.secho(f"✅ Found module '{module_name}'", fg="green")
+                return project["http_url_to_repo"]
+
+        typer.secho(f"❌ Module '{module_name}' not found in GitLab.", fg="yellow")
+        return None
+
+    except requests.RequestException as e:
+        typer.secho(f"❌ GitLab API error: {e}", fg="red")
+        return None
+
+
+def inject_token_into_url(url: str, token: str) -> str:
+    parsed = urlparse(url)
+    if not parsed.netloc:
+        raise ValueError(f"Invalid URL: {url}")
+    netloc = f"oauth2:{token}@{parsed.netloc}"
+    return urlunparse(parsed._replace(netloc=netloc, scheme="https"))
+
+
+def extract_module_name_from_url(url: str) -> str:
+    return url.rstrip("/").split("/")[-1].removesuffix(".git")
+
+
+def safe_eval_manifest(content: str) -> dict:
+    try:
+        return ast.literal_eval(content)
+    except Exception as e:
+        typer.secho(f"❌ Failed to evaluate manifest: {e}", fg="red")
+        return {}
+
+
+def clone_repo(url: str, target_dir: Path, branch: str = "main") -> bool:
+    if target_dir.exists():
+        typer.secho(f"⚠️  Skipping '{target_dir.name}': already exists.", fg="yellow")
+        return True
+    try:
+        access_token = get_access_token()
+        url_with_token = inject_token_into_url(url, access_token)
+        typer.secho(f"📥 Cloning into '{target_dir}'...", fg="cyan")
+        Repo.clone_from(url_with_token, target_dir, branch=branch)
+        typer.secho(f"✅ Successfully cloned '{url}'", fg="green")
+        return True
+    except GitCommandError as e:
+        typer.secho(f"❌ Git error: Failed to clone '{url}'\n{e}", fg="red")
+        return False
+    except Exception as e:
+        typer.secho(f"❌ Unexpected error: {e}", fg="red")
+        return False
+
+
+def clone_module_command(
+    url: str = typer.Option(..., "--url", help="Full HTTP URL of the module repo."),
+    branch: Optional[str] = None,
+    depth: int = typer.Option(1, "--depth", "-d", help="Max dependency depth to clone. 1 clones only the target module, 2 clones target + immediate dependencies, etc."),
+):
+    """
+    Clone a module and its dependencies into the current directory.
+    """
+    typer.secho("🚀 Starting module cloning process...", fg="cyan", bold=True)
+    core_modules = get_core_modules_from_config()
+    visited = set()
+    fail_count = 0
+    lock = threading.Lock()
+
+    def clone_recursive(module_url: str, current_branch: Optional[str], current_depth: int):
+        nonlocal fail_count
+        module_name = extract_module_name_from_url(module_url)
+
+        with lock:
+            if module_name in visited:
+                typer.secho(f"🔁 Already processed '{module_name}', skipping.", fg="yellow")
+                return False
+            visited.add(module_name)
+
+        target_path = Path.cwd() / module_name
+
+        if not clone_repo(module_url, target_path, current_branch or "main"):
+            typer.secho(f"❌ Failed to clone '{module_name}'. Skipping its dependencies.", fg="red")
+            with lock:
+                fail_count += 1
+            return False
+
+        if current_depth <= 0:
+            return False
+
+        manifest_path = target_path / "__manifest__.py"
+        if not manifest_path.exists():
+            typer.secho(f"📦 No manifest found in '{module_name}', skipping dependencies.", fg="yellow")
+            return True
+
+        manifest_data = safe_eval_manifest(manifest_path.read_text())
+        dependencies = manifest_data.get("depends", [])
+
+        if not dependencies:
+            typer.secho(f"ℹ️  No dependencies for '{module_name}'.", fg="blue")
+            return True
+
+        candidate_deps = [dep for dep in dependencies if dep not in core_modules]
+        if not candidate_deps:
+            return True
+
+        next_depth = current_depth - 1
+
+        def _resolve_and_run(dep_name: str):
+            dep_url = get_project_url_from_gitlab(module_name=dep_name)
+            if not dep_url:
+                typer.secho(f"❗ Could not resolve dependency: '{dep_name}'", fg="red")
+                nonlocal_assign = True
+                with lock:
+                    fail_count += 1
+                return
+            clone_recursive(dep_url, current_branch, next_depth)
+
+        with ThreadPoolExecutor(max_workers=4) as executor:
+            futures = [executor.submit(_resolve_and_run, dep) for dep in candidate_deps]
+            for f in futures:
+                f.result()
+
+        return True
+
+    clone_recursive(url, branch, depth)
+
+    if fail_count > 0:
+        typer.secho(f"⚠️  Finished with {fail_count} failed clones.", fg="yellow", bold=True)
+    else:
+        typer.secho("✅ All done without errors!", fg="green", bold=True)

odooflow_cli-0.1.0/odooflow/commands/config.py

@@ -0,0 +1,63 @@
+import typer
+from rich import print
+from typing import Optional
+
+from odooflow import config_manager
+
+def config(
+    env_file: str = typer.Option(None),
+    manifest_file: str = typer.Option(None),
+    access_token: str = typer.Option(None),
+    add_core_module: Optional[str] = typer.Option(None),
+    sync_keys: Optional[str] = typer.Option(None),
+    show: bool = typer.Option(False, "--show", help="Display current configuration")
+):
+    current_config = config_manager.load_config()
+    updated = False
+
+    if show:
+        typer.secho("📦 Current Configuration:", fg="cyan", bold=True)
+        print(current_config)
+        raise typer.Exit()
+
+    if env_file:
+        current_config["env_file"] = env_file
+        updated = True
+
+    if manifest_file:
+        current_config["manifest_file"] = manifest_file
+        updated = True
+
+    if access_token:
+        current_config["access_token"] = access_token
+        updated = True
+
+    if add_core_module:
+        modules = [m.strip() for m in add_core_module.split(",") if m.strip()]
+        if modules:
+            existing_modules = set(current_config.get(
+                "core_modules",
+                config_manager.DEFAULT_CONFIG.get("core_modules", [])
+            ))
+            new_modules = set(modules)
+            combined_modules = sorted(existing_modules.union(new_modules))
+            current_config["core_modules"] = combined_modules
+            updated = True
+            typer.secho(f"✅ Added core module(s): {', '.join(new_modules)}", fg="green")
+
+    if sync_keys:
+        new_keys = [k.strip() for k in sync_keys.split(",") if k.strip()]
+        existing_keys = set(current_config.get(
+            "sync_keys",
+            config_manager.DEFAULT_CONFIG['sync_keys'] 
+        ))
+        combined_keys = sorted(existing_keys.union(new_keys))
+        current_config["sync_keys"] = combined_keys
+        updated = True
+        typer.secho(f"🔑 Updated sync keys: {', '.join(new_keys)}", fg="cyan")
+
+    if updated:
+        config_manager.save_config(current_config)
+        typer.secho("💾 Configuration updated successfully.", fg="green")
+    else:
+        typer.secho("⚠️  No changes provided. Use --help to see available options.", fg="yellow")