rclone-api 1.0.0__tar.gz

rclone_api-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 zackees
+
+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.

rclone_api-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include pyproject.toml
+include requirements.testing.txt
+include template_python_cmd/assets/example.txt

rclone_api-1.0.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.2
+Name: rclone_api
+Version: 1.0.0
+Summary: rclone api in python
+Home-page: https://github.com/zackees/rclone-api
+Maintainer: Zachary Vorhies
+License: BSD 3-Clause License
+Keywords: template-python-cmd
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: home-page
+Dynamic: maintainer
+
+# template-python-cmd
+A template for quickly making a python lib that has a command line program attached
+
+[![Linting](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)
+
+[![MacOS_Tests](../../actions/workflows/push_macos.yml/badge.svg)](../../actions/workflows/push_macos.yml)
+[![Ubuntu_Tests](../../actions/workflows/push_ubuntu.yml/badge.svg)](../../actions/workflows/push_ubuntu.yml)
+[![Win_Tests](../../actions/workflows/push_win.yml/badge.svg)](../../actions/workflows/push_win.yml)
+
+Replace `template-python-cmd` and `template_python_cmd` with your command. Run tox until it's
+correct.
+
+To develop software, run `. ./activate.sh`
+
+# Windows
+
+This environment requires you to use `git-bash`.
+
+# Linting
+
+Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.

rclone_api-1.0.0/README.md

@@ -0,0 +1,21 @@
+# template-python-cmd
+A template for quickly making a python lib that has a command line program attached
+
+[![Linting](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)
+
+[![MacOS_Tests](../../actions/workflows/push_macos.yml/badge.svg)](../../actions/workflows/push_macos.yml)
+[![Ubuntu_Tests](../../actions/workflows/push_ubuntu.yml/badge.svg)](../../actions/workflows/push_ubuntu.yml)
+[![Win_Tests](../../actions/workflows/push_win.yml/badge.svg)](../../actions/workflows/push_win.yml)
+
+Replace `template-python-cmd` and `template_python_cmd` with your command. Run tox until it's
+correct.
+
+To develop software, run `. ./activate.sh`
+
+# Windows
+
+This environment requires you to use `git-bash`.
+
+# Linting
+
+Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.

rclone_api-1.0.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=65.5.1", "setuptools-scm", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rclone_api"
+readme = "README.md"
+description = "rclone api in python"
+requires-python = ">=3.7"
+keywords = ["template-python-cmd"]
+license = { text = "BSD 3-Clause License" }
+classifiers = ["Programming Language :: Python :: 3"]
+dependencies = [
+
+]
+# Change this with the version number bump.
+version = "1.0.0"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.ruff]
+line-length = 200
+
+[tool.pylint."MESSAGES CONTROL"]
+good-names = [
+    "c",
+    "i",
+    "ok",
+    "id",
+    "e",
+    "f"
+]
+disable = [
+    "missing-function-docstring",
+    "missing-module-docstring"
+]
+
+[tool.isort]
+profile = "black"
+
+[tool.mypy]
+ignore_missing_imports = true
+disable_error_code = ["import-untyped"]

rclone_api-1.0.0/requirements.testing.txt

@@ -0,0 +1,7 @@
+black
+isort
+mypy
+pytest
+tox
+ruff
+pytest-xdist

rclone_api-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

rclone_api-1.0.0/setup.py

@@ -0,0 +1,23 @@
+"""
+Setup file.
+"""
+
+import os
+import re
+
+from setuptools import setup
+
+URL = "https://github.com/zackees/rclone-api"
+KEYWORDS = "rclone api python"
+HERE = os.path.dirname(os.path.abspath(__file__))
+
+
+
+if __name__ == "__main__":
+    setup(
+        maintainer="Zachary Vorhies",
+        keywords=KEYWORDS,
+        url=URL,
+        package_data={"": ["assets/example.txt"]},
+        include_package_data=True)
+

rclone_api-1.0.0/src/rclone_api/assets/example.txt

@@ -0,0 +1 @@
+Example assets that will be deployed with python code.

rclone_api-1.0.0/src/rclone_api/cli.py

@@ -0,0 +1,15 @@
+"""
+Main entry point.
+"""
+
+import sys
+
+
+def main() -> int:
+    """Main entry point for the template_python_cmd package."""
+    print("Replace with a CLI entry point.")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

rclone_api-1.0.0/src/rclone_api/rclone.py

@@ -0,0 +1,160 @@
+"""
+Unit test file.
+"""
+
+import json
+import shutil
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+
+@dataclass
+class RcloneConfig:
+    """Rclone configuration dataclass."""
+
+    text: str
+
+
+def _rclone_execute(
+    cmd: list[str],
+    rclone_conf: Path | RcloneConfig,
+    rclone_exe: Path,
+    verbose: bool = False,
+) -> subprocess.CompletedProcess:
+    print(subprocess.list2cmdline(cmd))
+    tempdir: TemporaryDirectory | None = None
+
+    try:
+        if isinstance(rclone_conf, RcloneConfig):
+            tempdir = TemporaryDirectory()
+            tmpfile = Path(tempdir.name) / "rclone.conf"
+            tmpfile.write_text(rclone_conf.text, encoding="utf-8")
+            rclone_conf = tmpfile
+        cmd = (
+            [str(rclone_exe.resolve())] + ["--config", str(rclone_conf.resolve())] + cmd
+        )
+        if verbose:
+            cmd_str = subprocess.list2cmdline(cmd)
+            print(f"Running: {cmd_str}")
+        cp = subprocess.run(
+            cmd, capture_output=True, encoding="utf-8", check=True, shell=False
+        )
+        return cp
+    finally:
+        if tempdir:
+            try:
+                tempdir.cleanup()
+            except Exception as e:
+                print(f"Error cleaning up tempdir: {e}")
+
+
+@dataclass
+class RcloneExec:
+    """Rclone execution dataclass."""
+
+    rclone_config: Path | RcloneConfig
+    rclone_exe: Path
+
+    def execute(self, cmd: list[str]) -> subprocess.CompletedProcess:
+        """Execute rclone command."""
+        return _rclone_execute(cmd, self.rclone_config, self.rclone_exe)
+
+
+@dataclass
+class RemoteFile:
+    """Remote file dataclass."""
+
+    path: str
+    name: str
+    size: int
+    mime_type: str
+    mod_time: str
+    is_dir: bool
+    # is_bucket: bool
+
+    @staticmethod
+    def from_dict(data: dict) -> "RemoteFile":
+        """Create a RemoteFile from a dictionary."""
+        return RemoteFile(
+            data["Path"],
+            data["Name"],
+            data["Size"],
+            data["MimeType"],
+            data["ModTime"],
+            data["IsDir"],
+            # data["IsBucket"],
+        )
+
+    @staticmethod
+    def from_array(data: list[dict]) -> list["RemoteFile"]:
+        """Create a RemoteFile from a dictionary."""
+        out: list[RemoteFile] = []
+        for d in data:
+            file: RemoteFile = RemoteFile.from_dict(d)
+            out.append(file)
+        return out
+
+    @staticmethod
+    def from_json_str(json_str: str) -> list["RemoteFile"]:
+        """Create a RemoteFile from a JSON string."""
+        json_obj = json.loads(json_str)
+        if isinstance(json_obj, dict):
+            return [RemoteFile.from_dict(json_obj)]
+        return RemoteFile.from_array(json_obj)
+
+    def to_json(self) -> dict:
+        return {
+            "Path": self.path,
+            "Name": self.name,
+            "Size": self.size,
+            "MimeType": self.mime_type,
+            "ModTime": self.mod_time,
+            "IsDir": self.is_dir,
+            # "IsBucket": self.is_bucket,
+        }
+
+    def __str__(self) -> str:
+        out = self.to_json()
+        return json.dumps(out)
+
+
+def _get_rclone_exe(rclone_exe: Path | None) -> Path:
+    if rclone_exe is None:
+
+        rclone_which_path = shutil.which("rclone")
+        if rclone_which_path is None:
+            raise ValueError("rclone executable not found")
+        return Path(rclone_which_path)
+    return rclone_exe
+
+
+class Rclone:
+    def __init__(
+        self, rclone_conf: Path | RcloneConfig, rclone_exe: Path | None = None
+    ) -> None:
+        if isinstance(rclone_conf, Path):
+            if not rclone_conf.exists():
+                raise ValueError(f"Rclone config file not found: {rclone_conf}")
+        self._exec = RcloneExec(rclone_conf, _get_rclone_exe(rclone_exe))
+
+    def _run(self, cmd: list[str]) -> subprocess.CompletedProcess:
+        return self._exec.execute(cmd)
+
+    def ls(self, path: str) -> list[RemoteFile]:
+        cmd = ["lsjson", path]
+        cp = self._run(cmd)
+        text = cp.stdout
+        out: list[RemoteFile] = RemoteFile.from_json_str(text)
+        return out
+
+    def listremotes(self) -> list[str]:
+        cmd = ["listremotes"]
+        cp = self._run(cmd)
+        text = cp.stdout
+        out = text.splitlines()
+        out = [o.strip() for o in out]
+        # strip out ":" from the end
+        out = [o.replace(":", "") for o in out]
+        return out

rclone_api-1.0.0/src/rclone_api.egg-info/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.2
+Name: rclone_api
+Version: 1.0.0
+Summary: rclone api in python
+Home-page: https://github.com/zackees/rclone-api
+Maintainer: Zachary Vorhies
+License: BSD 3-Clause License
+Keywords: template-python-cmd
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: home-page
+Dynamic: maintainer
+
+# template-python-cmd
+A template for quickly making a python lib that has a command line program attached
+
+[![Linting](../../actions/workflows/lint.yml/badge.svg)](../../actions/workflows/lint.yml)
+
+[![MacOS_Tests](../../actions/workflows/push_macos.yml/badge.svg)](../../actions/workflows/push_macos.yml)
+[![Ubuntu_Tests](../../actions/workflows/push_ubuntu.yml/badge.svg)](../../actions/workflows/push_ubuntu.yml)
+[![Win_Tests](../../actions/workflows/push_win.yml/badge.svg)](../../actions/workflows/push_win.yml)
+
+Replace `template-python-cmd` and `template_python_cmd` with your command. Run tox until it's
+correct.
+
+To develop software, run `. ./activate.sh`
+
+# Windows
+
+This environment requires you to use `git-bash`.
+
+# Linting
+
+Run `./lint.sh` to find linting errors using `pylint`, `flake8` and `mypy`.

rclone_api-1.0.0/src/rclone_api.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+requirements.testing.txt
+setup.py
+src/rclone_api/__init__.py
+src/rclone_api/cli.py
+src/rclone_api/rclone.py
+src/rclone_api.egg-info/PKG-INFO
+src/rclone_api.egg-info/SOURCES.txt
+src/rclone_api.egg-info/dependency_links.txt
+src/rclone_api.egg-info/top_level.txt
+src/rclone_api/assets/example.txt
+tests/test_simple.py

rclone_api-1.0.0/src/rclone_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

rclone_api-1.0.0/src/rclone_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+rclone_api

rclone_api-1.0.0/tests/test_simple.py

@@ -0,0 +1,16 @@
+"""
+Unit test file.
+"""
+
+import unittest
+
+
+class RcloneTests(unittest.TestCase):
+    """Test rclone functionality."""
+
+    def test_list_remotes(self) -> None:
+        pass
+
+
+if __name__ == "__main__":
+    unittest.main()