Skip to content

Latest commit

 

History

History
128 lines (91 loc) · 3.79 KB

BOOTSTRAPPING-osx.md

File metadata and controls

128 lines (91 loc) · 3.79 KB
Raw

Running an instance of CivOmega

Local OS X

First-time setup

Install Homebrew if you don't have it

Homebrew needs some tools from Xcode. Install the Xcode compilers if you don't have a real copy of the Xcode app. If you do have Xcode, then skip ths command.

xcode-select --install

Install Homebrew. (It's safe to run the following command even if you do have brew installed, it'll just warn you about it. Don't do the "reinstall" step if you do get that warning.)

ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"

Set up an up-to-date Python environment, using Homebrew

Make sure Homebrew is up to date (so it knows about the latest software packages) and then install Python. It will take a while to build Python.

brew update
brew install python --with-brewed-openssl

(If you get a Error: python-2.X.X already installed of some sort, do brew upgrade python --with-brewed-openssl instead of brew install python --with-brewed-openssl.)

Now install some Python tools that will help you bootstrap your CivOmega Python environment. (You may need to sudo this command.)

/usr/local/bin/pip install -UI setuptools pip virtualenv

Download and initialize a CivOmega instance

Pick a place to store the CivOmega code. I usually put projects in a Code directory in my home folder, but you can adjust this accordingly. cd into that directory.

git clone https://github.com/CivOmega/civomega.git  # check out repo
virtualenv civomega  # make a` "virtual environment"

A Python virtual environment basically keeps an isolated set of Python libraries that don't interfere with your system's stuff.

Now we'll cd into the civomega repo and "activate" this environment. Then, using pip, we'll install all the Python libraries defined in the requirements.txt file. (This is sort of like a Ruby Gemfile.)

cd civomega
source bin/activate
pip install -r requirements.txt

Now you'll be able to use the Django tools to set up and use a database. For local installations, CivOmega is configured to use a dummy sqlite3 database by default. You can initialize the database by doing:

python manage.py syncdb --migrate --noinput
python manage.py update_patterns

The default modules include one which queries the Sunlight Foundation's APIs. So you'll need to have an API key if you want to use that one.

Once you have the API key, make sure you do this…

export SUNLIGHT_API_KEY=$YOUR_KEY_HERE

From here, you should be able to run the local server.

python manage.py runserver

…and opening your web browser to http://127.0.0.1:8000/.

Running the server normally

How to do the server stuff, after the first time around.

cd civomega
source bin/activate
python manage.py runserver

If someone's made an update to the requirements.txt, do the cd and source commands and then pip install -r requirements.txt.

If someone's made an update to a models.py file that requires a database change, simply do a python manage.py syncdb --migrate --noinput once again.

Frequent Errors

If you get a 500 error when trying to ask a question against the Sunlight API (check your terminal), try doing this…

pip install pyopenssl ndg-httpsclient pyasn1

…and then try running the server again.

When installing new modules...

When you edit a module's code, you'll want to run python manage.py update_patterns again so that the database knows about any new question/answer patterns your code has. (If you don't do this, your module probably won't show up when you type in a question in the CivOmega web interface!)