https://github.com/ibizaman/deluge-plugindev
Create a deluge plugin skeleton without setting up a python environment
https://github.com/ibizaman/deluge-plugindev
deluge deluge-plugin nix python skeleton
Last synced: 5 months ago
JSON representation
Create a deluge plugin skeleton without setting up a python environment
- Host: GitHub
- URL: https://github.com/ibizaman/deluge-plugindev
- Owner: ibizaman
- License: gpl-3.0
- Created: 2023-01-05T09:02:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T05:24:18.000Z (almost 3 years ago)
- Last Synced: 2025-02-16T19:34:26.021Z (8 months ago)
- Topics: deluge, deluge-plugin, nix, python, skeleton
- Language: Nix
- Homepage:
- Size: 66.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Deluge plugin dev env
This repository provides a turnkey Deluge plugin dev environment.
It allows you to create a new plugin, register it and start a
sandboxed `deluge` instance with that plugin.
Why you want this:
* No fiddling with python virtual env
* No need to clone deluge repo
* Fully reproducible thanks to nix
* Fully sandboxed environment
* Test plugin easily on web and gtk
## Tutorial
Start a `deluge` instance with a local config directory:
```bash
nix run github:ibizaman/deluge-plugindev#deluged -- \
--config .config
```
This creates a `.config` directory with the correct layout.
Start the web instance:
```bash
nix run github:ibizaman/deluge-plugindev#deluge-web -- \
--config .config
```
Go to http://localhost:8112/ to connect to it, the default password is
`deluge`.
Generate a plugin template:
```bash
nix run github:ibizaman/deluge-plugindev#createplugin -- \
--config .config \
--name MyPlugin \
--basepath . \
--author-name "Your Name" \
--author-email "yourname@example.com"
```
Then restart the `deluged` instance so it picks up the plugin:
```bash
nix run nixpkgs#killall .deluged-wrapped
nix run github:ibizaman/deluge-plugindev#deluged -- \
--config .config
```
And you'll see the plugin:
Happy hacking!