Skip to content

Latest commit

 

History

History
233 lines (173 loc) · 10.5 KB

README.md

File metadata and controls

233 lines (173 loc) · 10.5 KB

💾 Get the current version of Volux over at 🦊 the GitLab repository here.


📢 This repository contains an unmaintained legacy version of the Volux project from 2019...
What's the purpose of this repo now there's a new version?

The latest version of Volux doesn't have any publicly released modules yet. This legacy repo is being left open so that you can give Volux a test and still play around with the modules available in the legacy version.

How I can I find out when modules are available for the new version of Volux?

I'll announce public releases of modules on Twitter.

Where can I find modules released for the new version of Volux?

I'll provide links to public modules in the new GitLab repository.

What should I do if I have any other questions?

Please feel free to ask me any other questions over on Twitter.


Build Status Documentation Status codecov

PyPI Version GitHub release GitHub license Github all releases

Platform: Windows,Mac,Linux GitHub issues GitHub pull-requests

Volux

Description

Volux is a high-level media/entertainment workflow automation platform.

Demos

Demo Video

Volux Demo Video

Getting Started

Important Notes

Incompatibilities

Please note that pyaudio - a requirement of the voluxaudio module - does not support python versions above 3.6.9 on windows 10. Any version of Python 3.6.x should work fine.

Installation

Requirements

PACKAGE OPERATING SYSTEM REQUIREMENTS
Volux Any Python 3.x.x *
Volux Audio Any - Python 3.6.8 *
- Portaudio19 *
- Libasound2 *
Volux Gui Any - Tkinter **

* may already be installed on your OS, only install if install fails

** normally installed by default with python 3

Installing Volux and modules

To install Volux, enter the following into your operating system's CLI

  • Windows users, use powershell
  • Mac/Linux users, use terminal *

* note for Linux users: install in a virtual environment to avoid heartache

PACKAGE INSTALL COMMAND
Volux pip install volux
Volux Audio pip install voluxaudio
Volux Gui pip install voluxgui
Volux Light pip install voluxlight

Using Volux

Enter the following in your operating system's CLI

ACTION COMMAND
Launch Volux volux launch *
List commands volux --help

* make sure voluxgui is installed first or you'll get an error!

Documentation

For more information on how to use volux and how it works, check out the documentation here.

What does it do?

Volux operates using an Operator object and various instances of VoluxModule subclasses.

Each aspect of your media/entertainment setup is represented by it's own volux module.

The operator object acts as a hub for a standard method of communication between volux modules added to it.

These modules can read/write data of the associated aspects in coordination with each other to create seamless workflows.

Installing from source

See here.

Basic script for creating a workflow

Breakdown of setup

  1. Import the framework + essentials
import volux
  1. Import modules for use
from voluxcliprint import VoluxCliPrint
from voluxaudio import VoluxAudio
from voluxGui import VoluxGui
  1. Create operator object
vlx = VoluxOperator()
  1. Load the modules into the operator
vlx.add_module(VoluxCliPrint())
vlx.add_module(VoluxAudio())
vlx.add_module(
    VoluxGui(shared_modules=[vlx.audio,vlx.cli]),
    req_permissions=[
        volux.RequestNewConnection,
        volux.RequestGetConnections,
        volux.RequestStartSync
    ]
)
  1. Launch the GUI!
vlx.gui.init_window()

Issues and bugs

If you have any problems running Volux, please kindly post an issue to this repository. Issues can be solved much faster if you can provide:

  • Operating system
  • Desktop environment (if using Linux)
  • Python version
  • Summary of issues experienced
  • Relevant screenshot/s (if applicable)

Additional testing has been done under these conditions:

Archi. Operating System Desktop Env Python Verison Status Notes
64 bit Debian 10 Buster Gnome 3.30.2 3.7.3 0.9.18 Working Development conditions
64 bit Ubuntu 18.04 N/A 3.5 0.9.17 Working CI Conditions
64 bit Ubuntu 18.04 N/A 3.6 0.9.17 Working CI Conditions
64 bit Ubuntu 18.04 N/A 3.7 0.9.17 Working CI Conditions
64 bit Ubuntu 18.04 N/A 3.8 0.9.17 Working CI Conditions
64 bit Windows 10 N/A 3.7.8 0.9.17 Working -
64 bit OSX 10.13.5 N/A 3.7.3 0.9.17 Unsupported Ironing out the creases

forthebadge made-with-python