source: client/README.rst @ 45a52c6

Clients
=======

Rather than doing all the work server-side of submitting requests to SAO, certain work is done using a client program. Remit has two such clients -- one handles paper vouchers (which SAO stopped using in ~Fall 2010), and another handles RFPs (the current system, as of Summer 2014).

Configuration
-------------

Configuration is with a settings.py file in the same directory. It should
define:

`baseurl`
    the base of your Remit install (eg, ``baseurl`` + 'admin/' should give the admin)
`pathtpl`
    path into which to write output files (vouchers: LaTeX, PDFs; RFPs: CSV files of RFP info, documentation); this should be a ``printf``-style string with named parameters `label` and `ext`
`django_username` (optional)
    username to log in with; the script uses "downloader" if you don't override it
`password`
    password to log in with
`pdfviewer` (optional)
    PDF viewer to automatically launch after compiling the LaTeX (default: evince; only used for vouchers)

Vouchers
--------

``downloader.py`` will download voucher LaTeX from a Remit site, compile it, and allow you to print it. The ``mitvoucher`` LaTeX documentclass (`download <http://web.mit.edu/adehnert/Public/resources/treasury-forms/mitvoucher.cls>`_) must be available for ``downloader.py`` to compile the LaTeX it receives.

RFPs
----

The RFP submission system depends on Benjamin Tidor's `pysapweb <https://github.com/btidor/pysapweb/>`_, which itself requires Selenium. In general, refer to the `pysapweb documentation <http://pysapweb.readthedocs.org/en/latest/introduction.html>`_ for guidance getting that working.

Once pysapweb and Selenium are set up, download RFPs by running ``rfp.py``. If you get an error from pysapweb/Selenium about creating an ``x86`` or ``amd64`` directory because it already exists, you may need to delete that directory from the pysapweb template profile, in ``~/.pysapweb/``.