README.md

osc-tui

Designed to be a POC of a Outscale's Cockpit inside the terminal using curses.
The officially supported python version is currently 3.
The code is currently a bit dirty... Maybe big changes are coming!
To refresh any table, press [F5].
Feel free to suggest oher architectures, libs...
The src/ folder contains the project's sources.
The tests/ folder contain some crappy code used to test API calls or any other things...

Installation

You will need to install python3:

• Python3 (https://www.python.org/downloads/).

Now you can clone the repository:

• git clone https://github.com/outscale/osc-sdk-python.git

And then open the project's folder:

• cd osc-tui
• git submodule init
• git submodule update

Then setup a virtual environnement (Facultative but recommended):

• Install virtualenv: python3 -m pip install virtualenv
• Create the environnement: python3 -m virtualenv -p python3 env
• Activate it: source env/bin/activate.
• To exite use deactivate.

You will need to install:

• python3 -m pip install pyperclip.
• python3 -m pip install autopep8.
• OSC-SDK-Python (https://github.com/outscale/osc-sdk-python).

And now npyscreen:

• cd npyscreen
• python3 setup.py build
• python3 setup.py install
• cd ..

Finally run it!

• ./src/main.py

Contributing

Just a few rules:

• Format correctly your code (you can do autopep8 --in-place --aggressive --aggressive src/*.py).
• Format correctly your commits(myFolfder: what I Did, or myFolder/test.py: what I did).
• Add external dependencies as less as possible.

Note that the commit standard is new now so not really applied yet.