backupchan-client-lib 1.4.0__tar.gz

backupchan_client_lib-1.4.0/.gitignore

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

backupchan_client_lib-1.4.0/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Backup-chan client library changelog
+
+See what's changed between versions!
+
+## 1.4.0
+
+* Added support for minimum number of backups field.
+
+## 1.3.2
+
+* Hotfix for 1.3.1
+
+## 1.3.1
+
+* Added function to get human-readable timestamps for jobs.
+
+## 1.3.0
+
+* Added support for listing jobs and force running scheduled jobs.
+
+## 1.2.0
+
+* Added support for deleting recycled backups of target.
+
+## 1.1.0
+
+* Added support for sequential uploads.
+
+## 1.0.1
+
+* Fixed `upload_backup_folder` not returning value.
+
+## 1.0.0
+
+* **Breaking change**: Backup upload now returns ID of the job that is processing the upload instead of the backup ID.
+
+## 0.4.2
+
+* Fixed backup download function not respecting output directory.
+
+## 0.4.1
+
+* Fixed backup download function not returning downloaded filename.
+
+## 0.4.0
+
+* Added backup downloads.
+
+## 0.3.2
+
+* Stream files when doing file uploads.
+
+## 0.3.1
+
+* Fixed some functions not validating response.
+
+## 0.3.0
+
+* Added support for uploading directories directly.
+
+## 0.2.0
+
+* Added viewing stats.
+
+## 0.1.1
+
+Updated the `README.md` and `pyproject.toml` file.
+
+## 0.1.0
+
+The first stable version.

backupchan_client_lib-1.4.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-1.4.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: backupchan-client-lib
+Version: 1.4.0
+Summary: Library for interfacing with Backup-chan.
+Author-email: Moltony <koronavirusnyj@gmail.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/Backupchan/client-lib
+Project-URL: Repository, https://github.com/Backupchan/client-lib.git
+Project-URL: Issues, https://github.com/Backupchan/client-lib/issues
+Project-URL: Changelog, https://github.com/Backupchan/client-lib/blob/main/CHANGELOG.md
+Classifier: Development Status :: 5 - Production/Stable
+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
+
+![PyPI - License](https://img.shields.io/pypi/l/backupchan-client-lib)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/backupchan-client-lib)
+![PyPI - Version](https://img.shields.io/pypi/v/backupchan-client-lib)
+
+This is the Python library for interfacing with a Backup-chan server.
+
+## Installing
+
+```bash
+# The easy way
+pip install backupchan-client-lib
+
+# Install from source
+git clone https://github.com/Backupchan/client-lib.git backupchan-client-lib
+cd backupchan-client-lib
+pip install .
+```
+
+For instructions on setting up the server, refer to Backup-chan server's README.
+
+## Testing
+
+```
+pytest
+```
+
+## Example 
+
+```python
+from backupchan import *
+
+# Connect to a server
+api = API("http://192.168.1.43", 5000, "your api key")
+
+# Print every target
+targets = api.list_targets()
+for target in targets:
+    print(target)
+
+# Create a new target
+target_id = api.new_target(
+    "the waifu collection", # name
+    BackupType.MULTI,
+    BackupRecycleCriteria.AGE,
+    10, # recycle value
+    BackupRecycleAction.RECYCLE,
+    "/var/backups/waifu", # location
+    "wf-$I_$D", # name template
+    False, # deduplicate
+    None # alias
+)
+target = api.get_target(target_id)
+print(f"Created new target: {target}")
+```

backupchan_client_lib-1.4.0/README.md

@@ -0,0 +1,56 @@
+# Backup-chan client library
+
+![PyPI - License](https://img.shields.io/pypi/l/backupchan-client-lib)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/backupchan-client-lib)
+![PyPI - Version](https://img.shields.io/pypi/v/backupchan-client-lib)
+
+This is the Python library for interfacing with a Backup-chan server.
+
+## Installing
+
+```bash
+# The easy way
+pip install backupchan-client-lib
+
+# Install from source
+git clone https://github.com/Backupchan/client-lib.git backupchan-client-lib
+cd backupchan-client-lib
+pip install .
+```
+
+For instructions on setting up the server, refer to Backup-chan server's README.
+
+## Testing
+
+```
+pytest
+```
+
+## Example 
+
+```python
+from backupchan import *
+
+# Connect to a server
+api = API("http://192.168.1.43", 5000, "your api key")
+
+# Print every target
+targets = api.list_targets()
+for target in targets:
+    print(target)
+
+# Create a new target
+target_id = api.new_target(
+    "the waifu collection", # name
+    BackupType.MULTI,
+    BackupRecycleCriteria.AGE,
+    10, # recycle value
+    BackupRecycleAction.RECYCLE,
+    "/var/backups/waifu", # location
+    "wf-$I_$D", # name template
+    False, # deduplicate
+    None # alias
+)
+target = api.get_target(target_id)
+print(f"Created new target: {target}")
+```

backupchan_client_lib-1.4.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", "Stats", "SequentialFile"]

backupchan_client_lib-1.4.0/backupchan/api.py

@@ -0,0 +1,220 @@
+import io
+import os
+import tempfile
+import uuid
+import tarfile
+import dataclasses
+from typing import Generator
+from .connection import Connection, Response
+from .models import Backup, BackupTarget, BackupRecycleCriteria, BackupRecycleAction, BackupType, Stats, SequentialFile, DelayedJob, ScheduledJob
+
+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: Response) -> dict | Generator[bytes, None, None]:
+    if isinstance(response.json_body, Generator):
+        if response.status_code != 200:
+            raise BackupchanAPIError(f"Server returned error (code {response.status_code})", response.status_code)
+    elif not response.json_body.get("success", False):
+        raise BackupchanAPIError(f"Server returned error: {response.json_body} (code {response.status_code})", response.status_code)
+    return response.json_body
+
+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}")
+        resp_json = check_success(response)
+        targets = resp_json["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, min_backups: int | 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,
+            "min_backups": min_backups
+        }
+        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 the job that uploads the 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["job_id"]
+    
+    def upload_backup_folder(self, target_id: str, folder_path: str, manual: bool) -> str:
+        if not os.path.isdir(folder_path):
+            raise BackupchanAPIError("Cannot upload a single file in a directory upload")
+
+        # Cannot upload a directory to a single-file target.
+        target_type = self.get_target(target_id)[0].target_type
+        if target_type == BackupType.SINGLE:
+            raise BackupchanAPIError("Cannot upload directory to a single file target")
+
+        # Make a temporary gzipped tarball containing the directory contents.
+        temp_dir = tempfile.gettempdir()
+        temp_tar_path = os.path.join(temp_dir, f"bakch-{uuid.uuid4().hex}.tar.gz")
+        with tarfile.open(temp_tar_path, "w:gz") as tar:
+            tar.add(folder_path, arcname=os.path.basename(folder_path))
+        
+        # Upload our new tar.
+        with open(temp_tar_path, "rb") as tar:
+            return self.upload_backup(target_id, tar, os.path.basename(folder_path) + ".tar.gz", manual)
+
+    def download_backup(self, backup_id: str, output_directory: str) -> str:
+        response = self.connection.get_stream(f"backup/{backup_id}/download")
+        check_success(response)
+        filename = response.headers["Content-Disposition"].split("filename=")[-1].strip('"')
+        full_path = os.path.join(output_directory, filename)
+        with open(full_path, "wb") as file:
+            for chunk in response.json_body:
+                file.write(chunk)
+        return full_path
+
+    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, min_backups: int | 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_target_recycled_backups(self, id: str, delete_files: bool):
+        data = {
+            "delete_files": delete_files
+        }
+        response = self.connection.delete(f"target/{id}/recycled", 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"]
+    
+    def view_stats(self) -> Stats:
+        response = self.connection.get("stats")
+        resp_json = check_success(response)
+        return Stats.from_dict(resp_json)
+
+    def list_jobs(self) -> tuple[list[DelayedJob], list[ScheduledJob]]:
+        response = self.connection.get("jobs")
+        resp_json = check_success(response)
+        delayed_jobs = []
+        scheduled_jobs = []
+        for json_job in resp_json["delayed"]:
+            delayed_jobs.append(DelayedJob.from_dict(json_job))
+        for json_job in resp_json["scheduled"]:
+            scheduled_jobs.append(ScheduledJob.from_dict(json_job))
+        return delayed_jobs, scheduled_jobs
+
+    def force_run_job(self, name: str):
+        check_success(self.connection.get(f"jobs/force_run/{name}"))
+
+    def seq_begin(self, target_id: str, file_list: list[SequentialFile], manual: bool):
+        data = {
+            "manual": int(manual),
+            "file_list": [dataclasses.asdict(file) for file in file_list]
+        }
+        response = self.connection.post(f"seq/{target_id}/begin", data=data)
+        check_success(response)
+
+    def seq_check(self, target_id: str) -> list[SequentialFile]:
+        response = self.connection.get(f"seq/{target_id}")
+        resp_json = check_success(response)
+        return [SequentialFile.from_dict(file) for file in resp_json["file_list"]]
+
+    def seq_upload(self, target_id: str, file_io: io.IOBase, file: SequentialFile):
+        data = {
+            "name": file.name,
+            "path": file.path
+        }
+
+        files = {
+            "file": file_io
+        }
+
+        response = self.connection.post_form(f"seq/{target_id}/upload", data=data, files=files)
+        check_success(response)
+
+    def seq_finish(self, target_id: str):
+        response = self.connection.post(f"seq/{target_id}/finish", data={})
+        check_success(response)
+
+    def seq_terminate(self, target_id: str):
+        response = self.connection.post(f"seq/{target_id}/terminate", data={})
+        check_success(response)

backupchan_client_lib-1.4.0/backupchan/connection.py

@@ -0,0 +1,72 @@
+import requests
+import json
+import re
+from typing import Generator
+from dataclasses import dataclass
+
+@dataclass
+class Response:
+    json_body: dict | Generator[bytes, None, None] # is a generator when using get_stream
+    status_code: int
+    headers: dict
+
+def valid_api_key(api_key: str) -> bool:
+    return re.match(r"^bakch-([a-f]|[0-9]){64}$", api_key)
+
+class Connection:
+    def __init__(self, host: str, port: int, api_key: str):
+        if len(api_key.strip()) != 0 and not valid_api_key(api_key):
+            raise ValueError("Invalid API key")
+
+        if port < 0 or port > 65535:
+            raise ValueError("Port out of range")
+
+        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) -> Response:
+        response = requests.get(self.endpoint_url(endpoint), headers=self.headers())
+        if raise_on_error:
+            response.raise_for_status()
+        return Response(response.json(), response.status_code, response.headers)
+
+    def get_stream(self, endpoint: str, raise_on_error=False) -> Response:
+        response = requests.get(self.endpoint_url(endpoint), headers=self.headers(), stream=True)
+        if raise_on_error:
+            response.raise_for_status()
+        return Response(response.iter_content(chunk_size=8192), response.status_code, response.headers)
+
+    def post(self, endpoint: str, data: dict, raise_on_error=False) -> Response:
+        response = requests.post(self.endpoint_url(endpoint), headers=self.headers(), json=data)
+        if raise_on_error:
+            response.raise_for_status()
+        return Response(response.json(), response.status_code, response.headers)
+
+    def post_form(self, endpoint: str, data: dict, files: dict, raise_on_error=False) -> Response:
+        response = requests.post(self.endpoint_url(endpoint), headers=self.headers(), data=data, files=files, stream=True)
+        if raise_on_error:
+            response.raise_for_status()
+        return Response(response.json(), response.status_code, response.headers)
+
+    def patch(self, endpoint: str, data: dict, raise_on_error=False) -> Response:
+        response = requests.patch(self.endpoint_url(endpoint), headers=self.headers(), json=data)
+        if raise_on_error:
+            response.raise_for_status()
+        return Response(response.json(), response.status_code, response.headers)
+
+    def delete(self, endpoint: str, data: dict, raise_on_error=False) -> Response:
+        response = requests.delete(self.endpoint_url(endpoint), headers=self.headers(), json=data)
+        if raise_on_error:
+            response.raise_for_status()
+        return Response(response.json(), response.status_code, response.headers)

backupchan_client_lib-1.4.0/backupchan/models.py

@@ -0,0 +1,108 @@
+from enum import Enum
+from dataclasses import dataclass
+from typing import Optional
+from datetime import datetime
+
+def from_http_date(date):
+    return datetime.strptime(date, "%a, %d %b %Y %H:%M:%S GMT")
+
+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
+    min_backups: int | 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"], d["min_backups"])
+
+@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"])
+
+@dataclass
+class Stats:
+    program_version: str
+    total_target_size: int
+    total_recycle_bin_size: int
+    total_targets: int
+    total_backups: int
+    total_recycled_backups: int
+
+    @staticmethod
+    def from_dict(d: dict) -> "Stats":
+        return Stats(d["program_version"], d["total_target_size"], d["total_recycle_bin_size"], d["total_targets"], d["total_backups"], d["total_recycled_backups"])
+
+@dataclass
+class SequentialFile:
+    path: str
+    name: str
+    uploaded: bool
+
+    @staticmethod
+    def from_dict(d: dict) -> "SequentialFile":
+        return SequentialFile(d["path"], d["name"], d.get("uploaded", False))
+
+@dataclass
+class DelayedJob:
+    id: int
+    name: str
+    status: str
+    start_time: datetime
+    end_time: datetime
+
+    @staticmethod
+    def from_dict(d: dict) -> "DelayedJob":
+        return DelayedJob(d["id"], d["name"], d["status"], from_http_date(d["start_time"]), from_http_date(d["end_time"]))
+
+    def pretty_start_time(self) -> str:
+        return self.start_time.strftime("%B %d, %Y %H:%M")
+
+    def pretty_end_time(self) -> str:
+        return self.end_time.strftime("%B %d, %Y %H:%M")
+
+@dataclass
+class ScheduledJob:
+    name: str
+    interval: int
+    next_run: datetime
+
+    @staticmethod
+    def from_dict(d: dict) -> "ScheduledJob":
+        return ScheduledJob(d["name"], d["interval"], datetime.fromtimestamp(d["next_run"]))
+
+    def pretty_next_run(self) -> str:
+        return self.next_run.strftime("%B %d, %Y %H:%M")

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

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: backupchan-client-lib
+Version: 1.4.0
+Summary: Library for interfacing with Backup-chan.
+Author-email: Moltony <koronavirusnyj@gmail.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/Backupchan/client-lib
+Project-URL: Repository, https://github.com/Backupchan/client-lib.git
+Project-URL: Issues, https://github.com/Backupchan/client-lib/issues
+Project-URL: Changelog, https://github.com/Backupchan/client-lib/blob/main/CHANGELOG.md
+Classifier: Development Status :: 5 - Production/Stable
+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
+
+![PyPI - License](https://img.shields.io/pypi/l/backupchan-client-lib)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/backupchan-client-lib)
+![PyPI - Version](https://img.shields.io/pypi/v/backupchan-client-lib)
+
+This is the Python library for interfacing with a Backup-chan server.
+
+## Installing
+
+```bash
+# The easy way
+pip install backupchan-client-lib
+
+# Install from source
+git clone https://github.com/Backupchan/client-lib.git backupchan-client-lib
+cd backupchan-client-lib
+pip install .
+```
+
+For instructions on setting up the server, refer to Backup-chan server's README.
+
+## Testing
+
+```
+pytest
+```
+
+## Example 
+
+```python
+from backupchan import *
+
+# Connect to a server
+api = API("http://192.168.1.43", 5000, "your api key")
+
+# Print every target
+targets = api.list_targets()
+for target in targets:
+    print(target)
+
+# Create a new target
+target_id = api.new_target(
+    "the waifu collection", # name
+    BackupType.MULTI,
+    BackupRecycleCriteria.AGE,
+    10, # recycle value
+    BackupRecycleAction.RECYCLE,
+    "/var/backups/waifu", # location
+    "wf-$I_$D", # name template
+    False, # deduplicate
+    None # alias
+)
+target = api.get_target(target_id)
+print(f"Created new target: {target}")
+```

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

@@ -0,0 +1,17 @@
+.gitignore
+CHANGELOG.md
+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-1.4.0/backupchan_client_lib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

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

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

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

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

backupchan_client_lib-1.4.0/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "backupchan-client-lib"
+version = "1.4.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 :: 5 - Production/Stable",
+    "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"
+]
+
+[project.urls]
+Homepage = "https://github.com/Backupchan/client-lib"
+Repository = "https://github.com/Backupchan/client-lib.git"
+Issues = "https://github.com/Backupchan/client-lib/issues"
+Changelog = "https://github.com/Backupchan/client-lib/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "requests-mock"
+]

backupchan_client_lib-1.4.0/setup.cfg

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

backupchan_client_lib-1.4.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-1.4.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)
+
+        response = conn.get("target")
+
+        check_request(m, conn, "GET")
+
+        assert response.status_code == 200
+        assert response.json_body["success"] is True
+        assert len(response.json_body["targets"]) == 1
+        assert response.json_body["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"
+        }
+
+        response = conn.post("target", payload)
+
+        check_request(m, conn, "POST", payload)
+
+        assert response.status_code == 201
+        assert response.json_body["success"] is True
+        assert response.json_body["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")
+        }
+
+        response = 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 response.status_code == 200
+        assert response.json_body["success"] is True
+        assert response.json_body["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
+        }
+
+        response = conn.delete(f"target/{NULL_UUID}", data=payload)
+
+        check_request(m, conn, "DELETE", payload)
+
+        assert response.status_code == 200
+        assert response.json_body["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
+        }
+
+        response = conn.patch(f"backup/{NULL_UUID}", data=payload)
+
+        check_request(m, conn, "PATCH", payload)
+
+        assert response.status_code == 200
+        assert response.json_body["success"] is True

backupchan_client_lib-1.4.0/tests/test_models.py

@@ -0,0 +1,65 @@
+import datetime
+from backupchan.models import Backup, BackupType, BackupRecycleAction, BackupRecycleCriteria, BackupTarget, Stats
+
+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"]
+
+def test_stats_from_dict():
+    json_stats = {
+        "program_version": "1.1.0",
+        "total_target_size": 123456,
+        "total_recycle_bin_size": 654321,
+        "total_targets": 4,
+        "total_backups": 43,
+        "total_recycled_backups": 11
+    }
+
+    stats = Stats.from_dict(json_stats)
+    assert stats.program_version == json_stats["program_version"]
+    assert stats.total_target_size == json_stats["total_target_size"]
+    assert stats.total_recycle_bin_size == json_stats["total_recycle_bin_size"]
+    assert stats.total_targets == json_stats["total_targets"]
+    assert stats.total_backups == json_stats["total_backups"]
+    assert stats.total_recycled_backups == json_stats["total_recycled_backups"]