An open API service indexing awesome lists of open source software.

https://github.com/softlayer/slick


https://github.com/softlayer/slick

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

Slick
=====

Slick is a reference implementation for using the `SoftLayer Python Bindings `_. It implements a small web portal using a variety of open source projects to show the type of application you can build with the bindings.

.. WARNING::
This software is currently in active development. Some expertise is required for initial installation and setup.

Installation
------------
### Prerequirements
Starting with a fresh install of Ubuntu 14.04-64
```bash
apt-get install libpq-dev sqlite3 python-pip git python-dev
pip install WTForms wtforms-html5 WTForms-Components
pip install flask
pip install six --upgrade
```

### Get everything running

#### Getting the code
```bash
cd /usr/local/
git clone https://github.com/softlayer/slick.git
cd slick
python setup.py install
```
If setup.py failed to install, make sure you install any missing packages and try again before continuing. Usually the setup will complain about a missing package, so just use pip to install or upgrade it, and you should be ok.

#### Setup the database
```bash
alembic upgrade head
```

#### Configuration
Then you need to setup the config file. Just copy it to config.py, and edit the 2 secret strings.

If you don't want to have everything in /usr/local/slick make sure to change alembic.ini and config.py
```bash
cp config.py.sample config.py
export SLICK_CONFIG_FILE=/usr/local/slick/config.py
```
You will need to either add SLICK_CONFIG_FILE to your bashrc, or export it every time you reboot.

#### Finally running
This will start the web server on port 5000
```bash
python run.py
```
Then just head over to http://hostname:5000 and you should be able to login with your SoftLayer portal username and password.
To run the server as a daemon just add the & symbol to the end of that command. There is currently no init script or anything fancy like that.

I'll leave setting up nginx as an exersize for the reader.

System Requirements
-------------------
* This library has been tested on Python 2.7 only. It may work on other versions.
* A valid SoftLayer API username and key are required to call SoftLayer's API

Copyright
---------
This software is Copyright (c) 2013 SoftLayer Technologies, Inc.
See the bundled LICENSE file for more information.