forkbit-sdk 0.1.0__tar.gz

forkbit_sdk-0.1.0/.gitignore

@@ -0,0 +1,357 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,qt,qtcreator,visualstudiocode,macos,windows,linux
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,qt,qtcreator,visualstudiocode,macos,windows,linux
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Qt ###
+# C++ objects and libs
+*.slo
+*.lo
+*.o
+*.a
+*.la
+*.lai
+*.so.*
+*.dll
+*.dylib
+
+# Qt-es
+object_script.*.Release
+object_script.*.Debug
+*_plugin_import.cpp
+/.qmake.cache
+/.qmake.stash
+*.pro.user
+*.pro.user.*
+*.qbs.user
+*.qbs.user.*
+*.moc
+moc_*.cpp
+moc_*.h
+qrc_*.cpp
+ui_*.h
+*.qmlc
+*.jsc
+Makefile*
+*build-*
+*.qm
+*.prl
+
+# Qt unit tests
+target_wrapper.*
+
+# QtCreator
+*.autosave
+
+# QtCreator Qml
+*.qmlproject.user
+*.qmlproject.user.*
+
+# QtCreator CMake
+CMakeLists.txt.user*
+
+# QtCreator 4.8< compilation database
+compile_commands.json
+
+# QtCreator local machine specific files for imported projects
+*creator.user*
+
+*_qmlcache.qrc
+
+### QtCreator ###
+# gitignore for Qt Creator like IDE for pure C/C++ project without Qt
+#
+# Reference: http://doc.qt.io/qtcreator/creator-project-generic.html
+
+
+
+# Qt Creator autogenerated files
+
+
+# A listing of all the files included in the project
+*.files
+
+# Include directories
+*.includes
+
+# Project configuration settings like predefined Macros
+*.config
+
+# Qt Creator settings
+*.creator
+
+# User project settings
+*.creator.user*
+
+# Qt Creator backups
+
+# Flags for Clang Code Model
+*.cxxflags
+*.cflags
+
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/python,qt,qtcreator,visualstudiocode,macos,windows,linux
+
+.claude

forkbit_sdk-0.1.0/LICENSE

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

forkbit_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: forkbit-sdk
+Version: 0.1.0
+Summary: Plugin SDK for building ForkBit plugins
+Project-URL: Homepage, https://forkbit.de
+Project-URL: Documentation, https://docs.forkbit.de
+Author-email: ForkBit <hello@forkbit.de>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: app-store,forkbit,plugin,pyside6,qt,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.13
+Requires-Dist: pyside6>=6.11
+Provides-Extra: docs
+Requires-Dist: furo; extra == 'docs'
+Requires-Dist: sphinx-autobuild; extra == 'docs'
+Requires-Dist: sphinx-copybutton; extra == 'docs'
+Requires-Dist: sphinx-multiversion; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# ForkBit SDK
+
+Build plugins for [ForkBit](https://forkbit.de) — the desktop app for managing app store workflows.
+
+## Installation
+
+```bash
+pip install forkbit-sdk
+```
+
+## Quick Start
+
+Create a new plugin:
+
+```bash
+forkbit plugin init my_plugin
+```
+
+This generates a ready-to-run plugin scaffold:
+
+```
+my_plugin/
+  plugin.json    — manifest (id, name, version, dependencies)
+  main.py        — your plugin code (BasePlugin subclass)
+  settings.json  — settings schema
+```
+
+## Writing a Plugin
+
+Every plugin is a `BasePlugin` subclass that builds its UI in `on_ready()`:
+
+```python
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QLabel, QVBoxLayout
+
+from forkbit_sdk import BasePlugin
+
+
+class MyPlugin(BasePlugin):
+
+    def on_ready(self) -> None:
+        layout = QVBoxLayout(self.container)
+        layout.setAlignment(Qt.AlignmentFlag.AlignTop)
+
+        label = QLabel("Hello from my plugin!")
+        layout.addWidget(label)
+```
+
+Your plugin inherits the app's theme automatically — standard PySide6 widgets just work.
+
+## Plugin API
+
+| Property / Method | Description |
+|---|---|
+| `self.container` | QWidget — build your UI inside this |
+| `self.settings` | dict — current plugin settings values |
+| `self.project_id` | str — current project ID |
+| `self.project_path` | str — path to the project directory |
+| `self.data_dir` | Path — per-instance storage directory |
+| `self.git` | GitClient — git operations (status, tags, push, pull, commit) |
+| `self.read_json(filename)` | Read JSON from data_dir |
+| `self.write_json(filename, data)` | Atomic-write JSON to data_dir |
+| `self.notify(message, level)` | Show a toast notification |
+| `self.translate(text, src, tgt, on_done, on_error)` | Async translation |
+| `self.set_subtitle(text)` | Update the plugin header subtitle |
+| `self.secret_file(field_id)` | Get raw bytes of a secret file setting |
+| `on_ready()` | Override to build UI and initialize state |
+| `on_settings_changed(settings)` | Override to react to settings changes |
+
+## Settings Schema
+
+Define user-configurable settings in `settings.json`:
+
+```json
+{
+  "fields": [
+    { "id": "api_key", "label": "API Key", "type": "password" },
+    { "id": "auto_sync", "label": "Auto-sync on save", "type": "bool", "default": true }
+  ]
+}
+```
+
+Supported types: `text`, `password`, `textarea`, `bool`, `secret_file`.
+
+## Plugin Manifest
+
+`plugin.json` defines your plugin's metadata:
+
+```json
+{
+  "id": "com.mycompany.myplugin",
+  "name": "My Plugin",
+  "version": "1.0.0",
+  "description": "What it does",
+  "entry": "main.py",
+  "min_app_version": "0.2.0",
+  "requirements": []
+}
+```
+
+## CLI Commands
+
+```bash
+forkbit plugin init [dir]        # scaffold a new plugin
+forkbit plugin validate [dir]    # check manifest and imports
+forkbit plugin build [dir]       # build for current platform
+forkbit plugin release [dir]     # build for all platforms
+```
+
+## License
+
+MIT

forkbit_sdk-0.1.0/README.md

@@ -0,0 +1,112 @@
+# ForkBit SDK
+
+Build plugins for [ForkBit](https://forkbit.de) — the desktop app for managing app store workflows.
+
+## Installation
+
+```bash
+pip install forkbit-sdk
+```
+
+## Quick Start
+
+Create a new plugin:
+
+```bash
+forkbit plugin init my_plugin
+```
+
+This generates a ready-to-run plugin scaffold:
+
+```
+my_plugin/
+  plugin.json    — manifest (id, name, version, dependencies)
+  main.py        — your plugin code (BasePlugin subclass)
+  settings.json  — settings schema
+```
+
+## Writing a Plugin
+
+Every plugin is a `BasePlugin` subclass that builds its UI in `on_ready()`:
+
+```python
+from PySide6.QtCore import Qt
+from PySide6.QtWidgets import QLabel, QVBoxLayout
+
+from forkbit_sdk import BasePlugin
+
+
+class MyPlugin(BasePlugin):
+
+    def on_ready(self) -> None:
+        layout = QVBoxLayout(self.container)
+        layout.setAlignment(Qt.AlignmentFlag.AlignTop)
+
+        label = QLabel("Hello from my plugin!")
+        layout.addWidget(label)
+```
+
+Your plugin inherits the app's theme automatically — standard PySide6 widgets just work.
+
+## Plugin API
+
+| Property / Method | Description |
+|---|---|
+| `self.container` | QWidget — build your UI inside this |
+| `self.settings` | dict — current plugin settings values |
+| `self.project_id` | str — current project ID |
+| `self.project_path` | str — path to the project directory |
+| `self.data_dir` | Path — per-instance storage directory |
+| `self.git` | GitClient — git operations (status, tags, push, pull, commit) |
+| `self.read_json(filename)` | Read JSON from data_dir |
+| `self.write_json(filename, data)` | Atomic-write JSON to data_dir |
+| `self.notify(message, level)` | Show a toast notification |
+| `self.translate(text, src, tgt, on_done, on_error)` | Async translation |
+| `self.set_subtitle(text)` | Update the plugin header subtitle |
+| `self.secret_file(field_id)` | Get raw bytes of a secret file setting |
+| `on_ready()` | Override to build UI and initialize state |
+| `on_settings_changed(settings)` | Override to react to settings changes |
+
+## Settings Schema
+
+Define user-configurable settings in `settings.json`:
+
+```json
+{
+  "fields": [
+    { "id": "api_key", "label": "API Key", "type": "password" },
+    { "id": "auto_sync", "label": "Auto-sync on save", "type": "bool", "default": true }
+  ]
+}
+```
+
+Supported types: `text`, `password`, `textarea`, `bool`, `secret_file`.
+
+## Plugin Manifest
+
+`plugin.json` defines your plugin's metadata:
+
+```json
+{
+  "id": "com.mycompany.myplugin",
+  "name": "My Plugin",
+  "version": "1.0.0",
+  "description": "What it does",
+  "entry": "main.py",
+  "min_app_version": "0.2.0",
+  "requirements": []
+}
+```
+
+## CLI Commands
+
+```bash
+forkbit plugin init [dir]        # scaffold a new plugin
+forkbit plugin validate [dir]    # check manifest and imports
+forkbit plugin build [dir]       # build for current platform
+forkbit plugin release [dir]     # build for all platforms
+```
+
+## License
+
+MIT

forkbit_sdk-0.1.0/docs/_static/versioning.css

@@ -0,0 +1,44 @@
+.version-switcher {
+  padding: 0 var(--sidebar-item-spacing-horizontal);
+  margin-bottom: 1rem;
+}
+
+.version-switcher details {
+  border: 1px solid var(--color-sidebar-link-text);
+  border-radius: 4px;
+  padding: 0;
+}
+
+.version-switcher summary {
+  padding: 6px 12px;
+  cursor: pointer;
+  font-size: 0.85rem;
+  font-weight: 600;
+  color: var(--color-sidebar-link-text);
+  list-style: none;
+}
+
+.version-switcher summary::before {
+  content: "v ";
+}
+
+.version-switcher summary::-webkit-details-marker {
+  display: none;
+}
+
+.version-list {
+  display: flex;
+  flex-direction: column;
+  border-top: 1px solid var(--color-sidebar-link-text);
+}
+
+.version-list a {
+  padding: 6px 12px;
+  font-size: 0.85rem;
+  color: var(--color-sidebar-link-text);
+  text-decoration: none;
+}
+
+.version-list a:hover {
+  background: var(--color-sidebar-item-background--hover);
+}

forkbit_sdk-0.1.0/docs/_templates/versioning.html

@@ -0,0 +1,15 @@
+{% if versions %}
+<div class="version-switcher">
+  <details>
+    <summary>{{ current_version.name or 'dev' }}</summary>
+    <div class="version-list">
+      {% for item in versions.tags %}
+        <a href="{{ item.url }}">{{ item.name }}</a>
+      {% endfor %}
+      {% for item in versions.branches %}
+        <a href="{{ item.url }}">{{ item.name }} (dev)</a>
+      {% endfor %}
+    </div>
+  </details>
+</div>
+{% endif %}

forkbit_sdk-0.1.0/docs/api/base_plugin.rst

@@ -0,0 +1,7 @@
+BasePlugin
+==========
+
+.. autoclass:: forkbit_sdk.BasePlugin
+   :members:
+   :undoc-members:
+   :show-inheritance:

forkbit_sdk-0.1.0/docs/api/git_client.rst

@@ -0,0 +1,10 @@
+GitClient
+=========
+
+.. autoclass:: forkbit_sdk.GitClient
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autoexception:: forkbit_sdk.GitError
+   :show-inheritance: