mirror of
https://github.com/Ultimaker/Cura.git
synced 2025-07-10 16:27:51 -06:00
Rename Api to API
This commit is contained in:
parent
2fab1aef33
commit
5b5a8f77b7
2 changed files with 51 additions and 0 deletions
32
cura/API/Backups.py
Normal file
32
cura/API/Backups.py
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
# Copyright (c) 2018 Ultimaker B.V.
|
||||||
|
# Cura is released under the terms of the LGPLv3 or higher.
|
||||||
|
from cura.Backups.BackupsManager import BackupsManager
|
||||||
|
|
||||||
|
|
||||||
|
class Backups:
|
||||||
|
"""
|
||||||
|
The backups API provides a version-proof bridge between Cura's BackupManager and plugins that hook into it.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
from cura.API import CuraAPI
|
||||||
|
api = CuraAPI()
|
||||||
|
api.backups.createBackup()
|
||||||
|
api.backups.restoreBackup(my_zip_file, {"cura_release": "3.1"})
|
||||||
|
"""
|
||||||
|
|
||||||
|
manager = BackupsManager() # Re-used instance of the backups manager.
|
||||||
|
|
||||||
|
def createBackup(self) -> (bytes, dict):
|
||||||
|
"""
|
||||||
|
Create a new backup using the BackupsManager.
|
||||||
|
:return: Tuple containing a ZIP file with the backup data and a dict with meta data about the backup.
|
||||||
|
"""
|
||||||
|
return self.manager.createBackup()
|
||||||
|
|
||||||
|
def restoreBackup(self, zip_file: bytes, meta_data: dict) -> None:
|
||||||
|
"""
|
||||||
|
Restore a backup using the BackupManager.
|
||||||
|
:param zip_file: A ZIP file containing the actual backup data.
|
||||||
|
:param meta_data: Some meta data needed for restoring a backup, like the Cura version number.
|
||||||
|
"""
|
||||||
|
return self.manager.restoreBackup(zip_file, meta_data)
|
19
cura/API/__init__.py
Normal file
19
cura/API/__init__.py
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# Copyright (c) 2018 Ultimaker B.V.
|
||||||
|
# Cura is released under the terms of the LGPLv3 or higher.
|
||||||
|
from UM.PluginRegistry import PluginRegistry
|
||||||
|
from cura.API.Backups import Backups
|
||||||
|
|
||||||
|
|
||||||
|
class CuraAPI:
|
||||||
|
"""
|
||||||
|
The official Cura API that plugins can use to interact with Cura.
|
||||||
|
Python does not technically prevent talking to other classes as well,
|
||||||
|
but this API provides a version-safe interface with proper deprecation warnings etc.
|
||||||
|
Usage of any other methods than the ones provided in this API can cause plugins to be unstable.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# For now we use the same API version to be consistent.
|
||||||
|
VERSION = PluginRegistry.APIVersion
|
||||||
|
|
||||||
|
# Backups API.
|
||||||
|
backups = Backups()
|
Loading…
Add table
Add a link
Reference in a new issue