Package: hflossk
HFLOSSK=======.. image:: https://api.travis-ci.org/decause/hflossk.svgWat?----This repository is an experiment to use Flask, Mako, and Bootstrap to make awebsite for the Humanitarian Free/Open Source Software Course at RIT. Thisrepository is a work in progress (as any FOSS project is), and will be open forcontributions.The content shown here is a compilation of course materials from 4 previousprofessors, who've run the course 5 separate times. Those profs are:- Stephen Jacobs- Dave Shein (x2)- Ralph Bean- Justin SherrillLicense=======Copyright 2013 Remy DeCausemakerLicensed under the Apache License, Version 2.0 (the "License"); you may not usethis file except in compliance with the License.  You may obtain a copy of theLicense athttp://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributedunder the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES ORCONDITIONS OF ANY KIND, either express or implied.  See the License for thespecific language governing permissions and limitations under the License.Modifying the Courseware---------------------------Before you can do anything with this (run the webserver locally, or any of thescripts) you'll need to setup and activate a python `virtualenv<http://pypi.python.org/pypi/virtualenv>`_.  Run the following at the commandprompt...On Linux/Mac OS X+++++++++++++++++If you don't have virtualenv installed yet, try::$ sudo pip install virtualenv virtualenvwrapperIf you're using a distro like Fedora or Ubuntu, you should try this instead::Fedora:$ sudo yum install python-virtualenvUbuntu/Debian:$ sudo apt-get install python-virtualenvOnce you have virtualenv installed, you should be able to run::$ cd code$ git clone git@github.com:YOUR_USERNAME/hflossk.git$ virtualenv --no-site-packages -p python2 hflosskenv$ . hflosskenv/bin/activate$ cd hflossk$ python setup.py developOn Windows++++++++++At the windows command prompt::$ virtualenv --no-site-packages -p python2 hflosskenv$ hflosskenv/Scripts/activate.batIn msysGit or git-bash::$ git clone git@github.com:YOUR_USERNAME/hflossk.gitBack in the windows command prompt::$ cd hflossk$ python setup.py developCreating a New hflossk Course---------------------------Before you can do anything with this (run the webserver locally, or any of thescripts) you'll need to setup and activate a python `virtualenv<http://pypi.python.org/pypi/virtualenv>`_.  Run the following at the commandprompt...On Linux/Mac OS X+++++++++++++++++If you don't have virtualenv installed yet, try::$ sudo pip install virtualenv virtualenvwrapperIf you're using a distro like Fedora or Ubuntu, you should try this instead::Fedora:$ sudo yum install python-virtualenvUbuntu/Debian:$ sudo apt-get install python-virtualenvOnce you have virtualenv installed, you should be able to run::$ cd code$ git clone git@github.com:YOUR_USERNAME/YOUR_COURSENAME-content.git$ virtualenv --no-site-packages -p python2 hflosskenv$ pip install hflossk$ . ./hflosskenv/bin/activate$ cd YOUR_COURSENAME-content$ hflossk newOnce you've done that you'll probably want to edit some of thepre-generated files for the course. That way the website willreflect your course's information.On Windows++++++++++At the windows command prompt::$ virtualenv --no-site-packages -p python2 hflosskenv$ hflosskenv/Scripts/activate.bat$ pip install hflosskIn msysGit or git-bash::$ git clone git@github.com:YOUR_USERNAME/YOUR_COURSENAME-content.gitBack in the windows command prompt::$ cd YOUR_COURSENAME-content$ hflossk newOnce you've done that you'll probably want to edit some of thepre-generated files for the course. That way the website willreflect your course's information.Running the Tests----------------------------All tests are run using tox. To run the tests::$ virtualenv --no-site-packages -p python2 hflosskenv$ pip install tox$ toxTests check validity of all yaml, and the keys in any student yaml files. Testsalso checks that code conforms to PEP8.