Simple, Sane Course Scheduling.
YACS is a web-based course schedule with an emphasis on usability. It is also flexible enough to work with other school course data.
Send questions and comments to @jeffhui or jeff@jeffhui.net
If you're an RPI student and looking to use it, go to yacs.me
YACS is actively developed on Python 2.7. So go get that installed first. It's good python practice to put this project inside a virtualenv, but that's beyond the scope of this README.
You can download an archive from the top-right of the github page or clone the repo:
git clone https://github.com/jeffh/YACS
Which will download code into a YACS folder where you run this command.
YACS is built on top of Django 1.8. Thus, it requires a database driver to run. Install the appropriate driver and its database, or just use the bundled SQLite.
YACS uses a lot of dependencies. It relies on pip to install most of them. Simply do:
pip install -r requirements.txt
Which will install most of dependencies YACS needs for postgres. Depending on your
operating system, you'll probably need to install some system libraries for
libmemcached
, zlib
, libsasl
, psyocopg2
.
Edit DATABASES
variable in the yacs/settings/development.py
file to your
appropriate database settings.
Run the following commands. When calling syncdb, you'll be ask to create a superuser, it is purely optional, only the debug-toolbar is visible for logged in super-users.
python manage.py syncdb
python manage.py migrate
Next we need to get some data. Run these commands to import and setup the data for use. (These will take awhile).
python manage.py import_course_data # imports from RPI SIS + PDFs
python manage.py import_catalog_data # imports from RPI course catalog
python manage.py create_section_cache # creates cache for generating schedules
It is ok for these commands to emit parse errors.
Check it out by running the dev server python manage.py runserver
and pointing your
browser to http://localhost:8000/ and viola!
By default, YACS will hide the course data for manual review. Go to the django admin and make the semesters visible to see them in your user interface.
Vagrant is a tool which builds a development VM. The VM for
YACS is based on terrywant/archlinux and is provisioned by
vagrant.sh
. The development environment is contained in a python
virtualenv by berdario/pew. The development instance is
configured to use PostgreSQL.
After you have vagrant installed, to start developing, just:
vagrant up
to boot and provision the VM.cd /vagrant && pew workon yacs
to get in the working environment.Notes:
/vagrant
is shared between the host and the VM, so you can use whatever you like in the host to develop.Vagrantfile
as well.It's probably best to use the associated project: seafood. Which is a salt configuration project that can be used to set up a server for YACS.
The following environmental variables are used in production:
development
, but this should be
set to production
for production settings to take effect.When using seafood, you'll need to modify the salt configuration files to be unique for your installation. YACS uses email for notifying ADMINS in project settings.
After using seafood to set up the environment, use:
```
fab -H root@my-server deploy
```
To deploy YACS to the server. Updates can be deployed to the server in the same fashion.
Currently the project is laid out as follows:
There are still issues to tackle. Go to the GitHub issues page to see them all.