[go: up one dir, main page]

Skip to content

pat-rapidai/pyunraid

Repository files navigation

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

About

A Python library to interface with Unraid servers

Resources

License

Stars

Watchers

Forks

Packages

No packages published