Skip to content
A Python library to interface with Unraid servers
HTML Python CSS Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
pyunraid
tests
web
.gitattributes
.gitignore
.travis.yml
LICENSE.txt
MANIFEST
README.md
requirements-dev.txt
requirements.txt
setup.cfg
setup.py
test.py

README.md

pyunraid

Build Status

Pyunraid is a Python library designed to interface directly with an Unraid server without installing any software on directly on the server.

Installation

Use the package manager pip to install pyunraid.

pip install pyunraid

Usage

from pyunraid import Unraid

# Create Unraid server object
unraid = Unraid('192.168.1.4', 'root', 'your-secure-password')

# Get all Docker containers
containers = unraid.containers()

Documentation

Full documentation is available at https://pyunraid.simse.io/docs. The documentation is autogenerated supplimented with human written content

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GNU GPLv3

You can’t perform that action at this time.