backupchan-client-lib 0.1.0__tar.gz

backupchan_client_lib-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.egg-info
+*.swp
+build/
+*.bak
+dist/

backupchan_client_lib-0.1.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2025 moltony
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

backupchan_client_lib-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: backupchan-client-lib
+Version: 0.1.0
+Summary: Library for interfacing with Backup-chan.
+Author-email: Moltony <koronavirusnyj@gmail.com>
+License: BSD-3-Clause
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Archiving :: Backup
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: requests-mock; extra == "dev"
+Dynamic: license-file
+
+# Backup-chan client library
+
+This is the Python library for interfacing with a Backup-chan server.
+
+## Installing
+
+```bash
+# Normal install:
+pip install .
+# With extra dependencies for development:
+pip install .[dev]
+```
+
+For instructions on setting up the server, refer to Backup-chan server's README.
+
+## Testing
+
+```
+pytest
+```
+
+## Example 
+
+```python
+from backupchan import *
+
+api = API("http://192.168.1.43", 5000, "your api key")
+
+targets = api.list_targets()
+for target in targets:
+    print(target)
+
+target_id = api.new_target(
+    "the waifu collection",
+    BackupType.MULTI,
+    BackupRecycleCriteria.AGE,
+    10,
+    BackupRecycleAction.RECYCLE,
+    "/var/backups/waifu",
+    "wf-$I_$D",
+    False,
+    None
+)
+target = api.get_target(target_id)
+print(f"Created new target: {target}")
+```

backupchan_client_lib-0.1.0/README.md

@@ -0,0 +1,46 @@
+# Backup-chan client library
+
+This is the Python library for interfacing with a Backup-chan server.
+
+## Installing
+
+```bash
+# Normal install:
+pip install .
+# With extra dependencies for development:
+pip install .[dev]
+```
+
+For instructions on setting up the server, refer to Backup-chan server's README.
+
+## Testing
+
+```
+pytest
+```
+
+## Example 
+
+```python
+from backupchan import *
+
+api = API("http://192.168.1.43", 5000, "your api key")
+
+targets = api.list_targets()
+for target in targets:
+    print(target)
+
+target_id = api.new_target(
+    "the waifu collection",
+    BackupType.MULTI,
+    BackupRecycleCriteria.AGE,
+    10,
+    BackupRecycleAction.RECYCLE,
+    "/var/backups/waifu",
+    "wf-$I_$D",
+    False,
+    None
+)
+target = api.get_target(target_id)
+print(f"Created new target: {target}")
+```

backupchan_client_lib-0.1.0/backupchan/__init__.py

@@ -0,0 +1,5 @@
+from .connection import Connection
+from .models import *
+from .api import API, BackupchanAPIError
+
+__all__ = ["Connection", "BackupRecycleCriteria", "BackupRecycleAction", "BackupType", "BackupTarget", "Backup", "API", "BackupchanAPIError"]

backupchan_client_lib-0.1.0/backupchan/api.py

@@ -0,0 +1,121 @@
+import io
+from .connection import Connection
+from .models import Backup, BackupTarget, BackupRecycleCriteria, BackupRecycleAction, BackupType
+
+class BackupchanAPIError(Exception):
+    def __init__(self, message: str, status_code: int | None = None):
+        super().__init__(message)
+        self.status_code = status_code
+
+def check_success(response: tuple[dict, int]) -> dict:
+    data, status = response
+    if not data.get("success", False):
+        raise BackupchanAPIError(f"Server returned error: {data} (code {status})", status)
+    return data
+
+class API:
+    def __init__(self, host: str, port: int, api_key: str):
+        self.connection = Connection(host, port, api_key)
+
+    def list_targets(self, page: int = 1) -> list[BackupTarget]:
+        response = self.connection.get(f"target?page={page}")
+        targets = response[0]["targets"]
+        return [BackupTarget.from_dict(target) for target in targets]
+
+    def new_target(self, name: str, backup_type: BackupType, recycle_criteria: BackupRecycleCriteria, recycle_value: int, recycle_action: BackupRecycleAction, location: str, name_template: str, deduplicate: bool, alias: str | None) -> str:
+        """
+        Returns ID of new target.
+        """
+        data = {
+            "name": name,
+            "backup_type": backup_type,
+            "recycle_criteria": recycle_criteria,
+            "recycle_value": recycle_value,
+            "recycle_action": recycle_action,
+            "location": location,
+            "name_template": name_template,
+            "deduplicate": deduplicate,
+            "alias": alias
+        }
+        resp_json = check_success(self.connection.post("target", data))
+        return resp_json["id"]
+
+    def upload_backup(self, target_id: str, file: io.IOBase, filename: str, manual: bool) -> str:
+        """
+        Returns ID of new backup.
+        """
+        data = {
+            "manual": int(manual)
+        }
+
+        files = {
+            "backup_file": (filename, file)
+        }
+
+        response = self.connection.post_form(f"target/{target_id}/upload", data=data, files=files)
+        resp_json = check_success(response)
+        return resp_json["id"]
+
+    def get_target(self, id: str) -> tuple[BackupTarget, list[Backup]]:
+        response = self.connection.get(f"target/{id}")
+        resp_json = check_success(response)
+        return BackupTarget.from_dict(resp_json["target"]), [Backup.from_dict(backup) for backup in resp_json["backups"]]
+
+    def edit_target(self, id: str, name: str, recycle_criteria: BackupRecycleCriteria, recycle_value: int, recycle_action: BackupRecycleAction, location: str, name_template: str, deduplicate: bool, alias: str | None):
+        data = {
+            "name": name,
+            "recycle_criteria": recycle_criteria,
+            "recycle_value": recycle_value,
+            "recycle_action": recycle_action,
+            "location": location,
+            "name_template": name_template,
+            "deduplicate": deduplicate,
+            "alias": alias
+        }
+        response = self.connection.patch(f"target/{id}", data=data)
+        check_success(response)
+
+    def delete_target(self, id: str, delete_files: bool):
+        data = {
+            "delete_files": delete_files
+        }
+        response = self.connection.delete(f"target/{id}", data=data)
+        check_success(response)
+
+    def delete_target_backups(self, id: str, delete_files: bool):
+        data = {
+            "delete_files": delete_files
+        }
+        response = self.connection.delete(f"target/{id}/all", data=data)
+        check_success(response)
+
+    def delete_backup(self, id: str, delete_files: bool):
+        data = {
+            "delete_files": delete_files
+        }
+        response = self.connection.delete(f"backup/{id}", data=data)
+        check_success(response)
+
+    def recycle_backup(self, id: str, is_recycled: bool):
+        data = {
+            "is_recycled": is_recycled
+        }
+        response = self.connection.patch(f"backup/{id}", data=data)
+        check_success(response)
+
+    def list_recycled_backups(self) -> list[Backup]:
+        response = self.connection.get("recycle_bin")
+        resp_json = check_success(response)
+        return [Backup.from_dict(backup) for backup in resp_json["backups"]]
+
+    def clear_recycle_bin(self, delete_files: bool):
+        data = {
+            "delete_files": delete_files
+        }
+        response = self.connection.delete("recycle_bin", data=data)
+        check_success(response)
+
+    def get_log(self, tail: int) -> str:
+        response = self.connection.get(f"log?tail={tail}")
+        resp_json = check_success(response)
+        return resp_json["log"]

backupchan_client_lib-0.1.0/backupchan/connection.py

@@ -0,0 +1,49 @@
+import requests
+import json
+
+class Connection:
+    def __init__(self, host: str, port: int, api_key: str):
+        # TODO check these
+        self.api_key = api_key
+
+        if host.startswith("http://") or host.startswith("https://"):
+            server_host = host.rstrip("/")
+        else:
+            server_host = f"http://{host.rstrip('/')}"
+        self.base_url = f"{server_host}:{port}"
+
+    def endpoint_url(self, endpoint: str) -> str:
+        return f"{self.base_url}/api/{endpoint.rstrip('/')}"
+    
+    def headers(self) -> dict:
+        return {"Authorization": f"Bearer {self.api_key}"}
+
+    def get(self, endpoint: str, raise_on_error=False) -> tuple[dict, int]:
+        response = requests.get(self.endpoint_url(endpoint), headers=self.headers())
+        if raise_on_error:
+            response.raise_for_status()
+        return response.json(), response.status_code
+
+    def post(self, endpoint: str, data: dict, raise_on_error=False) -> tuple[dict, int]:
+        response = requests.post(self.endpoint_url(endpoint), headers=self.headers(), json=data)
+        if raise_on_error:
+            response.raise_for_status()
+        return response.json(), response.status_code
+
+    def post_form(self, endpoint: str, data: dict, files: dict, raise_on_error=False) -> tuple[dict, int]:
+        response = requests.post(self.endpoint_url(endpoint), headers=self.headers(), data=data, files=files)
+        if raise_on_error:
+            response.raise_for_status()
+        return response.json(), response.status_code
+
+    def patch(self, endpoint: str, data: dict, raise_on_error=False) -> tuple[dict, int]:
+        response = requests.patch(self.endpoint_url(endpoint), headers=self.headers(), json=data)
+        if raise_on_error:
+            response.raise_for_status()
+        return response.json(), response.status_code
+
+    def delete(self, endpoint: str, data: dict, raise_on_error=False) -> tuple[dict, int]:
+        response = requests.delete(self.endpoint_url(endpoint), headers=self.headers(), json=data)
+        if raise_on_error:
+            response.raise_for_status()
+        return response.json(), response.status_code

backupchan_client_lib-0.1.0/backupchan/models.py

@@ -0,0 +1,50 @@
+from enum import Enum
+from dataclasses import dataclass
+from typing import Optional
+from datetime import datetime
+
+class BackupRecycleCriteria(str, Enum):
+    NONE = "none"
+    COUNT = "count"
+    AGE = "age"
+
+class BackupRecycleAction(str, Enum):
+    DELETE = "delete"
+    RECYCLE = "recycle"
+
+class BackupType(str, Enum):
+    SINGLE = "single"
+    MULTI = "multi"
+
+@dataclass
+class BackupTarget:
+    id: str
+    name: str
+    target_type: BackupType
+    recycle_criteria: BackupRecycleCriteria
+    recycle_value: Optional[int]
+    recycle_action: BackupRecycleAction
+    location: str
+    name_template: str
+    deduplicate: bool
+    alias: str | None
+
+    @staticmethod
+    def from_dict(d: dict) -> "BackupTarget":
+        return BackupTarget(d["id"], d["name"], d["target_type"], d["recycle_criteria"], d["recycle_value"], d["recycle_action"], d["location"], d["name_template"], d["deduplicate"], d["alias"])
+
+@dataclass
+class Backup:
+    id: str
+    target_id: str
+    created_at: datetime
+    manual: bool
+    is_recycled: bool
+    filesize: int
+
+    def pretty_created_at(self) -> str:
+        return self.created_at.strftime("%B %d, %Y %H:%M")
+
+    @staticmethod
+    def from_dict(d: dict) -> "Backup":
+        return Backup(d["id"], d["target_id"], datetime.fromisoformat(d["created_at"]), d["manual"], d["is_recycled"], d["filesize"])

backupchan_client_lib-0.1.0/backupchan_client_lib.egg-info/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: backupchan-client-lib
+Version: 0.1.0
+Summary: Library for interfacing with Backup-chan.
+Author-email: Moltony <koronavirusnyj@gmail.com>
+License: BSD-3-Clause
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: System :: Archiving :: Backup
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: requests-mock; extra == "dev"
+Dynamic: license-file
+
+# Backup-chan client library
+
+This is the Python library for interfacing with a Backup-chan server.
+
+## Installing
+
+```bash
+# Normal install:
+pip install .
+# With extra dependencies for development:
+pip install .[dev]
+```
+
+For instructions on setting up the server, refer to Backup-chan server's README.
+
+## Testing
+
+```
+pytest
+```
+
+## Example 
+
+```python
+from backupchan import *
+
+api = API("http://192.168.1.43", 5000, "your api key")
+
+targets = api.list_targets()
+for target in targets:
+    print(target)
+
+target_id = api.new_target(
+    "the waifu collection",
+    BackupType.MULTI,
+    BackupRecycleCriteria.AGE,
+    10,
+    BackupRecycleAction.RECYCLE,
+    "/var/backups/waifu",
+    "wf-$I_$D",
+    False,
+    None
+)
+target = api.get_target(target_id)
+print(f"Created new target: {target}")
+```

backupchan_client_lib-0.1.0/backupchan_client_lib.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+backupchan/__init__.py
+backupchan/api.py
+backupchan/connection.py
+backupchan/models.py
+backupchan_client_lib.egg-info/PKG-INFO
+backupchan_client_lib.egg-info/SOURCES.txt
+backupchan_client_lib.egg-info/dependency_links.txt
+backupchan_client_lib.egg-info/requires.txt
+backupchan_client_lib.egg-info/top_level.txt
+tests/conftest.py
+tests/test_connection.py
+tests/test_models.py

backupchan_client_lib-0.1.0/backupchan_client_lib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

backupchan_client_lib-0.1.0/backupchan_client_lib.egg-info/requires.txt

@@ -0,0 +1,5 @@
+requests
+
+[dev]
+pytest
+requests-mock

backupchan_client_lib-0.1.0/backupchan_client_lib.egg-info/top_level.txt

@@ -0,0 +1 @@
+backupchan

backupchan_client_lib-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "backupchan-client-lib"
+version = "0.1.0"
+description="Library for interfacing with Backup-chan."
+authors = [
+    { name="Moltony", email="koronavirusnyj@gmail.com" } # but I probably won't respond...
+]
+dependencies = [
+    "requests"
+]
+
+readme = "README.md"
+license = {text = "BSD-3-Clause"}
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: System :: Archiving :: Backup",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed"
+]
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "requests-mock"
+]

backupchan_client_lib-0.1.0/setup.cfg

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

backupchan_client_lib-0.1.0/tests/conftest.py

@@ -0,0 +1,8 @@
+import pytest
+from backupchan import Connection
+
+TEST_TOKEN = "test-token"
+
+@pytest.fixture
+def conn():
+    return Connection("http://localhost", 5000, TEST_TOKEN)

backupchan_client_lib-0.1.0/tests/test_connection.py

@@ -0,0 +1,144 @@
+import uuid
+import io
+import pytest
+import requests_mock
+from backupchan import Connection
+
+# example responses all taken straight from the api docs
+
+NULL_UUID = "00000000-0000-0000-0000-000000000000"
+
+def check_request(mock: requests_mock.Mocker, conn: Connection, method: str, payload: None | dict = None):
+    last_request = mock.last_request
+    assert mock.called
+    assert last_request.method == method
+    assert last_request.headers["Authorization"] == conn.headers()["Authorization"]
+
+    if payload is not None:
+        if "application/json" in last_request.headers["Content-Type"]:
+            assert last_request.json() == payload
+        else:
+            assert last_request.text is not None
+
+def test_get(conn):
+    mock_response = {
+        "success": True,
+        "targets": [
+            {
+                "id": NULL_UUID,
+                "name": "My backup",
+                "target_type": "multi",
+                "recycle_criteria": "count",
+                "recycle_value": 10,
+                "recycle_action": "recycle",
+                "location": "/var/backups/MyBackup",
+                "name_template": "backup-$I-$D"
+            }
+        ]
+    }
+
+    with requests_mock.Mocker() as m:
+        m.get("http://localhost:5000/api/target", json=mock_response, status_code=200)
+
+        result, status = conn.get("target")
+
+        check_request(m, conn, "GET")
+
+        assert status == 200
+        assert result["success"] is True
+        assert len(result["targets"]) == 1
+        assert result["targets"][0]["name"] == "My backup"
+
+def test_post(conn):
+    mock_response = {
+        "success": True,
+        "id": NULL_UUID
+    }
+
+    with requests_mock.Mocker() as m:
+        m.post("http://localhost:5000/api/target", json=mock_response, status_code=201)
+
+        payload = {
+            "name": "Backupy",
+            "backup_type": "multi",
+            "recycle_criteria": "count",
+            "recycle_value": 10,
+            "recycle_action": "recycle",
+            "location": "/bakupy",
+            "name_template": "bkp-$I"
+        }
+
+        result, status = conn.post("target", payload)
+
+        check_request(m, conn, "POST", payload)
+
+        assert status == 201
+        assert result["success"] is True
+        assert result["id"] == NULL_UUID
+
+def test_post_form(conn):
+    mock_response = {
+        "success": True,
+        "id": NULL_UUID
+    }
+
+    test_uuid = str(uuid.uuid4())
+
+    with requests_mock.Mocker() as m:
+        m.post(f"http://localhost:5000/api/target/{test_uuid}/upload", json=mock_response, status_code=200)
+        
+        payload = {
+            "manual": False
+        }
+
+        files = {
+            "backup_file": io.BytesIO(b"i am file")
+        }
+
+        result, status = conn.post_form(f"target/{test_uuid}/upload", data=payload, files=files)
+
+        last_request = m.last_request
+        check_request(m, conn, "POST", payload)
+        assert "multipart/form-data" in last_request.headers["Content-Type"]
+
+        assert status == 200
+        assert result["success"] is True
+        assert result["id"] == NULL_UUID
+
+def test_delete(conn):
+    mock_response = {
+        "success": True
+    }
+
+    with requests_mock.Mocker() as m:
+        m.delete(f"http://localhost:5000/api/target/{NULL_UUID}", json=mock_response, status_code=200)
+
+        payload = {
+            "delete_files": True
+        }
+
+        result, status = conn.delete(f"target/{NULL_UUID}", data=payload)
+
+        check_request(m, conn, "DELETE", payload)
+
+        assert status == 200
+        assert result["success"] is True
+
+def test_patch(conn):
+    mock_response = {
+        "success": True
+    }
+
+    with requests_mock.Mocker() as m:
+        m.patch(f"http://localhost:5000/api/backup/{NULL_UUID}", json=mock_response, status_code=200)
+
+        payload = {
+            "is_recycled": True
+        }
+
+        result, status = conn.patch(f"backup/{NULL_UUID}", data=payload)
+
+        check_request(m, conn, "PATCH", payload)
+
+        assert status == 200
+        assert result["success"] is True

backupchan_client_lib-0.1.0/tests/test_models.py

@@ -0,0 +1,47 @@
+import datetime
+from backupchan.models import Backup, BackupType, BackupRecycleAction, BackupRecycleCriteria, BackupTarget
+
+def test_target_from_dict():
+    json_target = {
+        "id": "deadbeef-dead-beef-dead-beefdeadbeef",
+        "name": "touhoku kiritest",
+        "target_type": "multi",
+        "recycle_criteria": "count",
+        "recycle_value": 13,
+        "recycle_action": "recycle",
+        "location": "/var/backups/touhoku",
+        "name_template": "$I_kiritanpo",
+        "deduplicate": False,
+        "alias": None
+    }
+
+    target = BackupTarget.from_dict(json_target)
+    assert target.id == json_target["id"]
+    assert target.name == json_target["name"]
+    assert target.target_type == BackupType.MULTI
+    assert target.recycle_criteria == BackupRecycleCriteria.COUNT
+    assert target.recycle_value == json_target["recycle_value"]
+    assert target.recycle_action == BackupRecycleAction.RECYCLE
+    assert target.location == json_target["location"]
+    assert target.name_template == json_target["name_template"]
+    assert target.deduplicate == json_target["deduplicate"]
+    assert target.alias == json_target["alias"]
+
+def test_backup_from_dict():
+    created_at = datetime.datetime.now()
+    json_backup = {
+        "id": "d0d0caca-d0d0-caca-d0d0-cacad0d0caca",
+        "target_id": "deadbeef-dead-beef-dead-beefdeadbeef",
+        "created_at": created_at.isoformat(),
+        "manual": False,
+        "is_recycled": True,
+        "filesize": 123456
+    }
+
+    backup = Backup.from_dict(json_backup)
+    assert backup.id == json_backup["id"]
+    assert backup.target_id == json_backup["target_id"]
+    assert backup.created_at == created_at
+    assert backup.manual == json_backup["manual"]
+    assert backup.is_recycled == json_backup["is_recycled"]
+    assert backup.filesize == json_backup["filesize"]