Skip to content

For Developers: Setting Up A Development Environment [DEPRECATED]

Jump to bottom Edit New page
int3ll3ct edited this page Apr 8, 2017 · 1 revision

DEPRECATED

The information below is not relevant for Openroast 1.2. It was targeted at Openroast 1.0. see the other "For Developers" pages for up-to-date information. This info is being kept alive a while longer just in case...

Below is a set of instructions for setting up a development environment on your desired platform.

Drivers

Please refer to our wiki page on installing drivers to ensure you have the appropriate drivers installed.

Mac

Brew must be installed. Note: The newer version of Pyqt5 installed by brew requires that the requirements.txt file specify matplotlib version of 1.5.3.

brew install python3 PyQt5 qt5 pkg-config freetype
pip3 install virtualenv
git clone https://github.com/Roastero/Openroast.git
cd Openroast
virtualenv venv -p python3
source venv/bin/activate
pip3 install -r requirements.txt
export PYTHON_VERSION=$(python --version | sed -e 's/Python \(...\).*/\1/')
export PYQT5_VERSION=$(ls -rt /usr/local/Cellar/pyqt5 | tail -n 1)
cp -r /usr/local/Cellar/pyqt5/$PYQT5_VERSION/lib/python$PYTHON_VERSION/site-packages/PyQt5 venv/lib/python$PYTHON_VERSION/site-packages/
cp /usr/local/lib/python$PYTHON_VERSION/site-packages/sip* venv/lib/python$PYTHON_VERSION/site-packages/
python3 Openroast.py

Windows

Please install the following binaries if they are not already on your system:

Simply pip installing numpy and matplotlib may not work due to specific compiler and visual studio requirements. In order to bypass these requirements, download a pre-compiled version of numpy and matplotlib. Then, navigate to your downloads folder and run pip install PackageName.whl.

Once the above requirements are satisfied, run the following from Powershell.

git clone https://github.com/Roastero/Openroast.git
cd Openroast
pip install -r requirements.txt
python Openroast.py

Ubuntu Linux

sudo apt-get install git python3-pyqt5 python3-pip libfreetype6 libfreetype6-dev
git clone https://github.com/Roastero/Openroast.git
cd Openroast
pip3 install -r requirements.txt

Fedora Linux

sudo yum install python3-devel freetype-devel gcc gcc-c++
sudo pip3 install python-qt5
git clone https://github.com/Roastero/Openroast.git
cd Openroast
pip3 install -r requirements.txt
Add a custom footer

Welcome to the docs! If you come across any issues, please feel free to submit a pull request or add an issue to our issue tracker so we can be sure our documentation is up-to-date and accurate.

Clone this wiki locally