opencloudtool 0.5.1__cp312-cp312-macosx_11_0_arm64.whl

opencloudtool/__init__.py

@@ -0,0 +1,3 @@
+from .py_api import deploy, destroy, deploy_service
+
+__all__ = ["deploy", "destroy", "deploy_service"]

opencloudtool/py_api.py

@@ -0,0 +1,142 @@
+import os
+
+import logging
+from ._internal import deploy as _rust_deploy
+from ._internal import destroy as _rust_destroy
+from ._internal import init_logging as _rust_init_logging
+
+# A flag to ensure we only initialize the logger once per session.
+_logging_initialized = False
+
+logger = logging.getLogger(name=__name__)
+
+
+def init_logging():
+    """
+    Initializes the Rust logging system to show logs in the console.
+
+    This is called automatically by other functions like `deploy`,
+    so you don't typically need to call it yourself.
+    """
+    global _logging_initialized
+    if not _logging_initialized:
+        _rust_init_logging()
+        _logging_initialized = True
+
+
+def deploy(path: str = ".") -> None:
+    """
+    Deploys the application using the Rust core orchestrator.
+
+    Args:
+        path (str): The path to the project directory containing the
+                    `oct.toml` file. Defaults to the current directory.
+    """
+
+    init_logging()
+    project_path = os.path.abspath(path)
+    logger.info("[Python] Triggering deployment")
+
+    try:
+        _rust_deploy(project_path)
+        logger.info("[Python] Deployment call completed successfully.")
+    except (RuntimeError, IOError) as e:
+        logger.exception(f"[Python] An error occurred during deployment: {e}")
+        raise
+
+
+def destroy(path: str = ".") -> None:
+    """
+    Destroys the application using the Rust core orchestrator.
+
+    Args:
+        path (str): The path to the project directory containing the
+                    `oct.toml` file. Defaults to the current directory.
+    """
+
+    init_logging()
+    project_path = os.path.abspath(path)
+    logger.info("[Python] Triggering destroy")
+
+    try:
+        _rust_destroy(project_path)
+        logger.info("[Python] Destroy call completed successfully.")
+    except (RuntimeError, IOError) as e:
+        logger.exception(f"[Python] An error occurred during destroy process: {e}")
+        raise
+
+
+def deploy_service(path: str) -> None:
+    """
+    Automates the deployment of a standard FastAPI service.
+
+    This high-level function generates the necessary Dockerfile, requirements.txt,
+    and oct.toml, then calls the core deploy function.
+
+    Args:
+        path: The path to the FastAPI application's main.py file.
+    """
+    if not os.path.isfile(path) or not path.endswith("main.py"):
+        raise ValueError("The path must point to a 'main.py' file.")
+
+    absolute_path = os.path.abspath(path)
+    app_dir = os.path.dirname(absolute_path)
+    project_root = os.path.dirname(app_dir)
+    project_name = os.path.basename(project_root)
+
+    logger.info(f"Detected project root: '{project_root}' with name '{project_name}'")
+
+    dockerfile_content = """# Generated by opencloudtool
+FROM python:3.10-slim
+WORKDIR /code
+COPY ./requirements.txt /code/requirements.txt
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+COPY ./app /code/app
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
+"""
+
+    requirements_content = """# Generated by opencloudtool
+fastapi
+uvicorn[standard]
+"""
+
+    oct_toml_content = f"""# Generated by opencloudtool
+[project]
+name = "{project_name}"
+
+[project.state_backend.local]
+path = "./state.json"
+
+[project.user_state_backend.local]
+path = "./user_state.json"
+
+[project.services.app_1]
+image = ""
+dockerfile_path = "Dockerfile"
+internal_port = 80
+external_port = 80
+cpus = 250
+memory = 64
+"""
+
+    try:
+        dockerfile_path = os.path.join(project_root, "Dockerfile")
+        with open(dockerfile_path, "w") as f:
+            f.write(dockerfile_content)
+        logger.info(f"Generated Dockerfile at '{dockerfile_path}'")
+
+        reqs_path = os.path.join(project_root, "requirements.txt")
+        with open(reqs_path, "w") as f:
+            f.write(requirements_content)
+        logger.info(f"Generated requirements.txt at '{reqs_path}'")
+
+        toml_path = os.path.join(project_root, "oct.toml")
+        with open(toml_path, "w") as f:
+            f.write(oct_toml_content)
+        logger.info(f"Generated oct.toml at '{toml_path}'")
+
+    except IOError:
+        logger.exception("Error writing configuration files")
+        raise
+
+    deploy(project_root)

opencloudtool-0.5.1.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.4
+Name: opencloudtool
+Version: 0.5.1
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# Opencloudtool Python Library
+
+A tool to hide the complexity of the cloud, now available as a Python library.
+This library allows you to deploy services directly from your Python scripts.The core of this library is written in Rust
+for high performance and reliability.
+
+## Installation
+
+You can install the library from PyPI using `pip`
+
+```bash
+pip install opencloudtool
+
+```
+
+## Basic Usage
+
+To use the library, you need an `oct.toml` configuration file in your project directory.
+The library provides `deploy` and `destroy` functions to manage your stack.
+
+Example `deploy.py`
+
+```python
+import opencloudtool as oct
+
+# The path to the project directory containing oct.toml
+project_path = "./my-app"
+
+oct.deploy(path=project_path)
+```
+
+To destroy infrastructure:
+
+```python
+oct.destroy(path=project_path)
+```
+
+Main repo [opencloudtool](https://github.com/opencloudtool/opencloudtool)
+
+### Dev
+
+#### How it works: Python-Rust binding
+
+#### The connection between Python and Rust is managed by `maturin` and `PyO3`
+
+1. `maturin` compiles the Rust code in the `oct-py` crate into a native Python module.
+2. We configure the name of this compiled module in `pyproject.toml` to be `opencloudtool._internal`.
+3. The leading underscore (`_`) is a standard Python convention that signals that `_internal` is a low-level module not meant for direct use.
+4. Our user-facing Python code in `opencloudtool/py_api.py` imports functions from `_internal` and presents them as a clean, stable API.
+
+#### 1. Navigate to the Python Directory
+
+```bash
+cd crates/oct-py
+```
+
+#### 2. Create and activate the Virtual environment
+
+```bash
+uv venv
+
+source .venv/bin/activate # Windows: .venv\Scripts\activate
+```
+
+#### 3. Install dependencies
+
+```bash
+uv sync --group dev
+```
+
+#### 4. Build the Library
+
+```bash
+maturin develop
+```
+
+#### 5. Run the example
+
+```bash
+cd ../../examples/projects/single-host-python-lib
+```
+
+You can now run `python deploy.py` or `python destroy.py` to test your changes.
+
+### Releasing the Python Library
+
+#### Bump the Version Number
+
+1. Before releasing, you must increment the version number. PyPI will not accept a version that already exists.
+
+- `crates/oct-py/pyproject.toml`
+
+2. Build & upload the Release Packages:
+
+```bash
+cd crates/oct-py
+
+maturin sdist
+
+maturin build --release
+
+cd ../..
+
+twine upload target/wheels/*
+```
+

opencloudtool-0.5.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+opencloudtool-0.5.1.dist-info/METADATA,sha256=0sDGv7SBEtfqNAPCNKky-G2e5dXTQ1KN54Fbd-2yrzA,2492
+opencloudtool-0.5.1.dist-info/WHEEL,sha256=EhaWXx4fd8VOPM6W-6pxsePGk73OLk2gBi7fwS90pc8,104
+opencloudtool/__init__.py,sha256=RzuIGV6BftKGFsuqfw1urrSufsxbxZnZn_CWEjAdGHA,103
+opencloudtool/__pycache__/__init__.cpython-312.pyc,sha256=1Q_Q8xgrzm_g0_3OgIlKG0uFtOepaxHEs4KwkSAgu6c,304
+opencloudtool/__pycache__/py_api.cpython-312.pyc,sha256=FMvwCuCgBgJpVzBCrCMucuF9y2kj6JCPNZE00OiyXlo,6261
+opencloudtool/_internal.cpython-312-darwin.so,sha256=C0jwPMAdxHTj2MXF1oVSH7ceNxrO4vTfDkboirLaeKg,35447808
+opencloudtool/py_api.py,sha256=q98gH-qmx5TRRUdewEkeoILrlcMmXfcK5kfCzRAfkZw,4179
+opencloudtool-0.5.1.dist-info/RECORD,,

opencloudtool-0.5.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.3)
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_11_0_arm64