Skip to main content

A wafer-thin Django library for running small conferences.

Project description

wafer

Travis CI build status Wafer documentation

A wafer-thin web application for running small conferences. Built using Django.

Licensed under the ISC License.

Documentation

Available on readthedocs.org.

Supported Django versions

Wafer supports Django 1.11 and Django 2.0.

Installation

  1. wafer can be installed either from pypi (pip install wafer) or from the github repository.

  2. If installing from github, pip install -r requirements.txt should install all the required python and django dependencies.

  3. Wafer uses npm to manage front-end dependencies

    • Make sure you have a recent version of Node.js installed that includes npm.

    • Run npm install to install all dependencies, which also copies them to wafer/static/vendor.

  4. Install the wafer applications manage.py migrate

  5. If you don’t have one yet, create a superuser with manage.py createsuperuser.

  6. Examine the settings.py file and create a localsettings.py file overriding the defaults as required.

    STATIC_FILES, WAFER_MENUS, MARKITUP_FILTER, WAFER_TALKS_OPEN, WAFER_REGISTRATION_OPEN and WAFER_PUBLIC_ATTENDEE_LIST will probably need to be overridden.

    If you add extensions to MARKITUP_FILTER, be sure to install the appropriate python packages as well.

  7. Log in and configure the Site:

    • The domain will be used as the base for e-mails sent during registration.

    • The name will be the conference’s name.

  8. Wafer uses the Django caching infrastructure in several places, so the cache table needs to be created using manage.py createcachetable.

  9. Create the default ‘Page Editors’ and ‘Talk Mentors’ groups using manage.py wafer_add_default_groups.

  10. Have a fun conference.

Installing Bootstrap

The default templates and css files require jquery and bootstrap to work.

wafer provides a bower.json file to simplify the installation process. This requires a working nodejs installation.

  1. Install bower npm install bower

  2. Use bower to install appropriate versions of bootstrap and jquery $(npm bin)/bower install

  3. Move files to the correct location manage.py collectstatic

Features

  • Support for adding and editing sponsors via Django admin.

  • Schedule can be created and updated via Django admin.

  • Pages for static content, news and so forth can be handled via Django admin.

    • Can be delegated to the ‘Page Editors’ group.

    • Pages can be updated via the web interface.

  • Talk submissions, review and acceptance.

  • Generate a static version of the site for archival.

TODO

  • Make the code easier to use for other conferences (split out theming, etc.).

  • Improve the talk submission management module:

    • Better display of accepted talks.

  • Make various messages easier to customise.

  • Improve admin support for the schedule:

    • Show table of slots in admin interface.

    • Improve handling of moving talks around.

  • Support for adding news (and other templated pages) via Django admin.

  • Maybe add some cool visualizations with d3:

    • Number of people signed up in various categories.

    • Places remaining.

    • Sponsorship slots remaining.

    • Days until various deadlines.

  • Other improvements

  • Add many tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wafer-0.7.5.tar.gz (147.3 kB view details)

Uploaded Source

Built Distributions

wafer-0.7.5-py3-none-any.whl (193.5 kB view details)

Uploaded Python 3

wafer-0.7.5-py2-none-any.whl (193.1 kB view details)

Uploaded Python 2

File details

Details for the file wafer-0.7.5.tar.gz.

File metadata

  • Download URL: wafer-0.7.5.tar.gz
  • Upload date:
  • Size: 147.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for wafer-0.7.5.tar.gz
Algorithm Hash digest
SHA256 ff5f70601e9302f2c138478c1081ef16baf8ac581295e0082b1820376c5f866f
MD5 b3ba1d26940c41088ff18c6816d9349c
BLAKE2b-256 1ee84b49a99c87e7d0c9ea0cf2237c92ec62335635621c7480171039d698646d

See more details on using hashes here.

File details

Details for the file wafer-0.7.5-py3-none-any.whl.

File metadata

  • Download URL: wafer-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 193.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for wafer-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 81364e591d4e07f59e3e9e411305ff0f31f39e87c1911d1f803b7e1a520e6c19
MD5 68c2010395dc0b094e83c6dd6c6ae59e
BLAKE2b-256 dc9957d256cc48ebb7c066c7936db319c0f84fc37b38514c032c74dd8f5b72fd

See more details on using hashes here.

File details

Details for the file wafer-0.7.5-py2-none-any.whl.

File metadata

  • Download URL: wafer-0.7.5-py2-none-any.whl
  • Upload date:
  • Size: 193.1 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3

File hashes

Hashes for wafer-0.7.5-py2-none-any.whl
Algorithm Hash digest
SHA256 0c78008dd7c77adfb80efab1febe303dd1fbaba4325be605254a41373a4926f7
MD5 fbfcc67af54e277b32c45045e2d02444
BLAKE2b-256 4fc458f9b089274d8b0648c1dafbbfa5d120fa908b0a39b2bef94b2c62fc63c8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page