Proposer is a Flask powered script that automatically generates html proposals from yaml data files. It has been tested on the following configuration:
- MacOS X 10.7.5
- Python 2.7.5
Proposer requires the following in order to run properly:
- Xcode
- Command Line Tools
- Python >= 2.7 (MacOS X comes with python preinstalled)
Open Terminal
Applications > Terminal.app
Clone repo (inside Terminal) - First time only
cd path/to/downloads
git clone https://github.com/reubano/proposer.git
Install python modules (inside Terminal) - First time only
cd path/to/downloads/proposer
sudo easy_install pip
sudo pip install -r requirements.txt
Create proposals (inside Terminal) - Any time
cd path/to/downloads/proposer
./manage.py propose
Proposer comes with a built in script manager manage.py. Use it to create proposals.
path/to/downloads/proposer/manage.py propose [-h] [-s STYLE] [-i INFO]
The following examples assume you have first run cd path/to/downloads/proposer
Use the default info.yml file
./manage.py propose
Use a custom template style
./manage.py propose -s research
Use a custom yaml file (you can drag and drop the file into the terminal instead of typing in the path)
./manage.py propose -i path/to/custom.yml
Show the help menu
./manage.py propose -h
All proposal details are located in the yaml file info.yml.
Proposer is distributed under the BSD License, the same as Flask on which this program depends.