Taking one out of PyCon's (US) book

We're lock-step with symposion, and upstream is dead.
Vendor it.
This commit is contained in:
Sachi King 2017-05-27 20:05:44 +10:00
parent 4a5e4dc6ea
commit d95d66dac8
146 changed files with 0 additions and 1061 deletions

6
.gitignore vendored
View file

@ -1,6 +0,0 @@
_build
*.pyc
dev.db
site_media
*.egg-info
.DS_Store

View file

@ -1,11 +0,0 @@
language: python
python:
- 2.7
install:
- pip install flake8
- pip install -e .
script:
- flake8 symposion

View file

@ -1,7 +0,0 @@
[main]
host = https://www.transifex.com
[symposion.djangopo]
file_filter = symposion/locale/<lang>/LC_MESSAGES/django.po
source_lang = en
source_file = symposion/locale/en/LC_MESSAGES/django.po

View file

@ -1,162 +0,0 @@
# How to Contribute
There are many ways you can help contribute to symposion and the various apps,
themes, and starter projects that it is made up of. Contributing code, writing
documentation, reporting bugs, as well as reading and providing feedback on
issues and pull requests, all are valid and necessary ways to
help.
## Committing Code
The great thing about using a distributed versioning control system like git
is that everyone becomes a committer. When other people write good patches
it makes it very easy to include their fixes/features and give them proper
credit for the work.
We recommend that you do all your work in a separate branch. When you
are ready to work on a bug or a new feature create yourself a new branch. The
reason why this is important is you can commit as often you like. When you are
ready you can merge in the change. Let's take a look at a common workflow:
git checkout -b task-566
... fix and git commit often ...
git push origin task-566
The reason we have created two new branches is to stay off of `master`.
Keeping master clean of only upstream changes makes yours and ours lives
easier. You can then send us a pull request for the fix/feature. Then we can
easily review it and merge it when ready.
### Writing Commit Messages
Writing a good commit message makes it simple for us to identify what your
commit does from a high-level. There are some basic guidelines we'd like to
ask you to follow.
A critical part is that you keep the **first** line as short and sweet
as possible. This line is important because when git shows commits and it has
limited space or a different formatting option is used the first line becomes
all someone might see. If your change isn't something non-trivial or there
reasoning behind the change is not obvious, then please write up an extended
message explaining the fix, your rationale, and anything else relevant for
someone else that might be reviewing the change. Lastly, if there is a
corresponding issue in Github issues for it, use the final line to provide
a message that will link the commit message to the issue and auto-close it
if appropriate.
Add ability to travel back in time
You need to be driving 88 miles per hour to generate 1.21 gigawatts of
power to properly use this feature.
Fixes #88
## Coding style
When writing code to be included in symposion keep our style in mind:
* Follow [PEP8](http://www.python.org/dev/peps/pep-0008/) there are some
cases where we do not follow PEP8. It is an excellent starting point.
* Follow [Django's coding style](http://docs.djangoproject.com/en/dev/internals/contributing/#coding-style)
we're pretty much in agreement on Django style outlined there.
We would like to enforce a few more strict guides not outlined by PEP8 or
Django's coding style:
* PEP8 tries to keep line length at 80 characters. We follow it when we can,
but not when it makes a line harder to read. It is okay to go a little bit
over 80 characters if not breaking the line improves readability.
* Use double quotes not single quotes. Single quotes are allowed in cases
where a double quote is needed in the string. This makes the code read
cleaner in those cases.
* Blank lines are indented to the appropriate level for the block they are in.
* Docstrings always use three double quotes on a line of their own, so, for
example, a single line docstring should take up three lines not one.
* Imports are grouped specifically and ordered alphabetically. This is shown
in the example below.
* Always use `reverse` and never `@models.permalink`.
* Tuples should be reserved for positional data structures and not used
where a list is more appropriate.
* URL patterns should use the `url()` function rather than a tuple.
Here is an example of these rules applied:
# first set of imports are stdlib imports
# non-from imports go first then from style import in their own group
import csv
# second set of imports are Django imports with contrib in their own
# group.
from django.core.urlresolvers import reverse
from django.db import models
from django.utils import timezone
from django.utils.translation import ugettext_lazy as _
from django.contrib.auth.models import User
# third set of imports are external apps (if applicable)
from tagging.fields import TagField
# fourth set of imports are local apps
from .fields import MarkupField
class Task(models.Model):
"""
A model for storing a task.
"""
creator = models.ForeignKey(User)
created = models.DateTimeField(default=timezone.now)
modified = models.DateTimeField(default=timezone.now)
objects = models.Manager()
class Meta:
verbose_name = _("task")
verbose_name_plural = _("tasks")
def __unicode__(self):
return self.summary
def save(self, **kwargs):
self.modified = datetime.now()
super(Task, self).save(**kwargs)
def get_absolute_url(self):
return reverse("task_detail", kwargs={"task_id": self.pk})
# custom methods
class TaskComment(models.Model):
# ... you get the point ...
pass
## Pull Requests
Please keep your pull requests focused on one specific thing only. If you
have a number of contributions to make, then please send seperate pull
requests. It is much easier on maintainers to receive small, well defined,
pull requests, than it is to have a single large one that batches up a
lot of unrelated commits.
If you ended up making multiple commits for one logical change, please
rebase into a single commit.
git rebase -i HEAD~10 # where 10 is the number of commits back you need
This will pop up an editor with your commits and some instructions you want
to squash commits down by replacing 'pick' with 's' to have it combined with
the commit before it. You can squash multiple ones at the same time.
When you save and exit the text editor where you were squashing commits, git
will squash them down and then present you with another editor with commit
messages. Choose the one to apply to the squashed commit (or write a new
one entirely.) Save and exit will complete the rebase. Use a forced push to
your fork.
git push -f

View file

@ -1,4 +0,0 @@
include README LICENSE
recursive-include symposion/templates *.html *.txt
recursive-include symposion/static *
recursive-include symposion/locale *

View file

@ -1,74 +0,0 @@
Symposion
---------
.. image:: http://slack.pinaxproject.com/badge.svg
:target: http://slack.pinaxproject.com/
.. image:: https://img.shields.io/travis/pinax/symposion.svg
:target: https://travis-ci.org/pinax/symposion
.. image:: https://img.shields.io/coveralls/pinax/symposion.svg
:target: https://coveralls.io/r/pinax/symposion
.. image:: https://img.shields.io/pypi/dm/symposion.svg
:target: https://pypi.python.org/pypi/symposion/
.. image:: https://img.shields.io/pypi/v/symposion.svg
:target: https://pypi.python.org/pypi/symposion/
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://pypi.python.org/pypi/symposion/
Pinax
------
Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates.
This collection can be found at http://pinaxproject.com.
symposion
----------
``symposion`` is a conference management solution from Eldarion. It was built with the generous support of the Python Software Foundation. See http://eldarion.com/symposion/ for commercial support, customization and hosting.
Quickstart
==========
To install ``symposion``, run:
pip install symposion
``symposion`` is a Django app. You will need to create a Django project to
customize and manage your Symposion installation. We have built a basic
Django startproject template that includes ``symposion`` (https://github.com/pinax/pinax-project-symposion).
Documentation
---------------
The ``symposion`` documentation is available at https://symposion.readthedocs.org/en/latest/.
The Pinax documentation is available at http://pinaxproject.com/pinax/.
Contribute
----------------
See this blog post http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/ including a video, or our How to Contribute (http://pinaxproject.com/pinax/how_to_contribute/) section for an overview on how contributing to Pinax works. For concrete contribution ideas, please see our Ways to Contribute/What We Need Help With (http://pinaxproject.com/pinax/ways_to_contribute/) section.
In case of any questions, we recommend you join our Pinax Slack team (http://slack.pinaxproject.com) and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course also valid but we are usually able to help you faster if you ping us in Slack.
We also highly recommend reading our Open Source and Self-Care blog post (http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).
Code of Conduct
----------------
In order to foster a kind, inclusive, and harassment-free community, the Pinax Project has a code of conduct, which can be found here http://pinaxproject.com/pinax/code_of_conduct/. We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.
Pinax Project Blog and Twitter
-------------------------------
For updates and news regarding the Pinax Project, please follow us on Twitter at @pinaxproject and check out our blog http://blog.pinaxproject.com.

View file

@ -1,153 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PinaxSymposion.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PinaxSymposion.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PinaxSymposion"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PinaxSymposion"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

View file

@ -1,242 +0,0 @@
# -*- coding: utf-8 -*-
#
# Pinax Symposion documentation build configuration file, created by
# sphinx-quickstart on Sun Feb 5 17:31:13 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Pinax Symposion'
copyright = u'2012, Eldarion Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.5'
# The full version, including alpha/beta/rc tags.
release = '0.5dev'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'PinaxSymposiondoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'PinaxSymposion.tex', u'Pinax Symposion Documentation',
u'Eldarion Team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pinaxsymposion', u'Pinax Symposion Documentation',
[u'Eldarion Team'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'PinaxSymposion', u'Pinax Symposion Documentation',
u'Eldarion Team', 'PinaxSymposion', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

View file

@ -1,40 +0,0 @@
Conference App
==============
The overall conference settings are managed via the ``conference`` app.
Conferences and their sections are added and configured via the Django admin.
Models
------
Each conference needs an instance of a ``Conference`` model. In most cases you
will only need one of these but Symposion does support multiple conferences
sharing a database. Similar to the Django Sites framework, the conference your
project is for is selected by the ``CONFERENCE_ID`` setting which defaults to
``1`` but can be changed to the pk of another conference if you have more than
one.
The conference model has an optional ``start_date`` and ``end_date``
indicating when the conference will run. These are optional so you can begin
to configure your conference even if you don't know the exact dates.
The conference model also has a ``timezone`` field which you should set to the
timezone your conference will be in.
There is also a ``Section`` model. This is useful if your conference has
different parts to it that run of different days with a different management,
review or scheduling process. Example of distinct sections might be
"Tutorials", "Talks", "Workshops", "Sprints", "Expo". Many aspects of
Symposion can be configured on a per-section basis.
Each section has an optional ``start_date`` and ``end_date`` similar to the
overall conference.
Helper Functions
----------------
A ``conference.models.current_conference()`` function exists to retrieve the
``Conference`` selected by ``CONFERENCE_ID``.

View file

@ -1,34 +0,0 @@
Pinax Symposion
===============
Pinax Symposion is an open-source conference management system written in
Django. Symposion includes support for content management, proposal
submission, reviews, scheduling and sponsor management.
.. toctree::
:maxdepth: 2
project
conference
content
proposals
sponsorship
speakers
schedule
About
-----
Symposion came out of development done by Eldarion for DjangoCon US and US PyCon
but has been independently used for a number of other conferences.
The project homepage is http://eldarion.com/symposion/
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View file

@ -1,10 +0,0 @@
Project Template
================
The `pinax-project-symposion <https://github.com/pinax/pinax-project-symposion>`_ repository
is a starter project demonstrating how to create a minimal symposion instance.
TODO:
* initial data
* overriding templates
* deployment

View file

@ -1,111 +0,0 @@
Proposals App
=============
Models
------
ProposalSection
~~~~~~~~~~~~~~~
Recall that a symposion instance consists of one or more ``Conference``s each
made up of one or more ``Section``s.
Different sections can have different open / close dates for proposals.
This is managed through a ``ProposalSection`` which is a one-to-one with
``Section`` where you can define a ``start`` date, an ``end`` date and/or
simply toggle proposals for the section ``closed``.
A section is available for proposals iff:
* it is after the ``start`` (if there is one) and
* it is before the ``end`` (if there is one) and
* ``closed`` is NULL or False
In other words, ``closed`` can be used as an override, regardless of ``start``
and ``end`` and, if you want, you can just manually use ``closed`` rather than
setting dates.
This model is currently managed by conference staff via the Django admin
although given it's part of "conference setup", it may often just be a
fixture that's loaded.
ProposalKind
~~~~~~~~~~~~
A conference, even within a section, may have different kinds of
presentations, e.g. talks, panels, tutorials, posters.
If these have different requirements for what fields should be in the
proposal form, they should be modeled as different ``ProposalKind``s. For
example, you may want talk proposals to include an intended audience level
but not require that for poster submissions.
Note that if you have different deadlines, reviews, etc. you'll want to
distinguish the **section** as well as the kind.
This model is currently managed by conference staff via the Django admin
although given it's part of "conference setup", it may often just be a
fixture that's loaded.
ProposalBase
~~~~~~~~~~~~
Each proposal kind should have a subclass of ``ProposalBase`` defining the
fields for proposals of that kind. We discuss below how that association is
made.
``ProposalBase`` provides fields for a ``title``, a single-paragraph
plain-text ``description`` and an ``abstract`` which can contain markup.
There is also an ``additional_notes`` field which can be used for speakers to
communicate additional information about their proposal to reviewers that is
not intended to be shared with others.
This base model supports each proposal having multiple speakers (although
the submitting speaker is always treated differently) and also supports
the attachments of supporting documents for reviewers that are, like the
``additional_notes`` not intended to be shared with others.
A ``cancelled`` boolean field is also provided to indicate that a proposal
has been cancelled or withdrawn.
AdditionalSpeaker
~~~~~~~~~~~~~~~~~
Used for modeling the additional speakers on a proposal in additional to the
submitting speaker. The status of an additional speaker may be ``Pending``,
``Accepted`` or ``Declined``.
.. todo:: see note in speakers docs about explaining the flow
SupportingDocument
~~~~~~~~~~~~~~~~~~
Used for modeling the supporting documents that can be attached to a proposal.
How to Add Custom Proposal Kinds
--------------------------------
For each kind:
* create a ``ProposalKind`` instance
* subclass ``ProposalBase`` and add the fields you want
* define a Django ``ModelForm`` for proposals of that kind
* make sure your settings file has a ``PROPOSAL_FORMS`` dictionary
that maps the slug of your ``ProposalKind`` to the fully-qualified
name of your ``ModelForm``.
For example::
PROPOSAL_FORMS = {
"tutorial": "pycon.forms.PyConTutorialProposalForm",
"talk": "pycon.forms.PyConTalkProposalForm",
"poster": "pycon.forms.PyConPosterProposalForm",
}

View file

@ -1,49 +0,0 @@
Schedule App
===========
The ``schedule`` app allows staff members to create the schedule for the
conference's presentations, breaks, lunches, etc.
The ```schedule``` app has a number of models that facilitate building the
structured schedule:
* Schedule: A high level container that maps to each Conference Section.
* Day: A Day associated with a Schedule.
* Room: A Room associated with a Schedule.
* Slot Kind: A type of Slot associated with a Schedule.
* Slot: A discrete time period for a Schedule.
* Slot Room: A mapping of a Room and Slot for a given Schedule.
* Presentation: A mapping of a Slot to an approved Proposal from the ```proposals``` app.
Schedule Builder Form
---------------------
It can be cumbersome to generate a schedule through the admin. With that in mind,
a generic schedule builder is available via a Schedule's edit view. For instance,
if a Conference site has a Talks Section and Schedule, the form would be
available for Staff at::
/schedule/talks/edit
The form consumes a structured CSV file, from which it will build the schedule.
Sample CSV data is included below::
"date","time_start","time_end","kind"," room "
"12/12/2013","10:00 AM","11:00 AM","plenary","Room2"
"12/12/2013","10:00 AM","11:00 AM","plenary","Room1"
"12/12/2013","11:00 AM","12:00 PM","talk","Room1"
"12/12/2013","11:00 AM","12:00 PM","talk","Room2"
"12/12/2013","12:00 PM","12:45 PM","plenary","Room1"
"12/12/2013","12:00 PM","12:45 PM","plenary","Room2"
"12/13/2013","10:00 AM","11:00 AM","plenary","Room2"
"12/13/2013","10:00 AM","11:00 AM","plenary","Room1"
"12/13/2013","11:00 AM","12:00 PM","talk","Room1"
"12/13/2013","11:00 AM","12:00 PM","talk","Room2"
"12/13/2013","12:00 PM","12:45 PM","plenary","Room1"
"12/13/2013","12:00 PM","12:45 PM","plenary","Room2"
It is worth noting that this generates the **structure** of the schedule. It
does not create Presentation objects. This will need to be done manually.
One can also **delete** an existing schedule via the delete action. This is
irreversible (save for a database restore).

View file

@ -1,22 +0,0 @@
Speaker App
===========
The ``speaker`` app allows speakers to set up their profile, prior to or as
part of the proposal submission phase. The **dashboard** is the means through
which speakers manage their own profiles.
We are planning to make the Speaker model more pluggable so, if you have
particular fields you'd like your speakers to fill out, you'll be able to
customize things more easily.
Additional Speakers
-------------------
Because ``symposion`` supports additional speakers being attached to a
proposal or actual presentation, it has the notion of a ``Speaker`` that is
not yet a ``User`` on the site. For this reason, a ``Speaker`` may have a
NULL ``user`` field (hopefully temporarily) as well as an ``invite_email``
and ``invite_token`` field for the invitation sent to the additional speaker
to join.
.. todo:: perhaps explain the invitation flow

View file

@ -1,82 +0,0 @@
Sponsorship App
===============
Sponsorship is managed via the ``sponsorship`` app.
Sponsorship levels and sponsors are added via the Django admin.
Models
------
Each sponsor level has a ``name`` (e.g. "Gold", "Silver") and an ``order``
field which is an integer that is used to sort levels (lowest first). Each
level also has a ``description`` which is not currently exposed anywhere
but can be used for private annotation.
Each sponsor has a ``name``, ``external_url`` (i.e. link to the sponsor's
website), ``contact_name`` and ``contact_email``, ``logo``, and ``level``.
A sponsor may also have a private ``annotation`` that can be used by
organizers to take notes about the sponsor.
A sponsor will not appear on the site until the ``active`` flag is set true.
Template Snippets
-----------------
The easiest way to include sponsor logos, grouped by level, is to either::
{% include "sponsorship/_vertical_by_level.html" %}
or::
{% include "sponsorship/_horizontal_by_level.html" %}
You can get a wall of sponsors (without level designation) with::
{% include "sponsorship/_wall.html" %}
You can always tweak these templates or use them as the basis for your own.
This is often all you'll need to do to display sponsors on your site.
If you want to display a specific sponsor logo you can use::
{% include "sponsorship/_sponsor_link.html" with sponsor=sponsor %}
or::
{% include "sponsorship/_sponsor_link.html" with sponsor=sponsor dimensions="100x100" %}
if you want different dimensions than the default 150 x 150.
Template Tags
-------------
If you want to retrieve the sponsors and traverse them yourself, you can use
the provided template tags::
{% load sponsorship_tags %}
{% sponsors as all_sponsors %}
or::
{% load sponsorship_tags %}
{% sponsors "Gold" as gold_sponsors %}
if you want to just get a specific level.
You can get the levels with::
{% load sponsorship_tags %}
{% sponsor_levels as levels %}
and you can always iterate over those levels, calling ``level.sponsors`` to
get the sponsors at that level.

View file

@ -1,12 +0,0 @@
Django==1.9.7
django-appconf==1.0.1
django-model-utils>=2.6.1
django-reversion==1.10.1
django-sitetree>=1.7.0
django-taggit==0.18.0
django-timezone-field>=2.0
easy-thumbnails==2.3
bleach
markdown==2.6.5
pytz==2015.7
django-ical==1.4

View file

@ -1,3 +0,0 @@
# requirements needed to build the docs
Sphinx==1.1.3

View file

@ -1,36 +0,0 @@
#!/usr/bin/env python
import os
from setuptools import setup, find_packages
import symposion
def read_file(filename):
"""Read a file into a string."""
path = os.path.abspath(os.path.dirname(__file__))
filepath = os.path.join(path, filename)
try:
return open(filepath).read()
except IOError:
return ''
setup(
name="symposion",
author="James Tauber",
author_email="jtauber@jtauber.com",
version=symposion.__version__,
description="A collection of Django apps for conference websites.",
url="http://eldarion.com/symposion/",
packages=find_packages(),
include_package_data=True,
classifiers=(
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3 :: Only",
"Framework :: Django",
"Intended Audience :: Developers",
"Natural Language :: English",
"License :: OSI Approved :: MIT License",
),
install_requires=read_file("requirements/base.txt").splitlines(),
)

View file

@ -1,3 +0,0 @@
[flake8]
ignore = E501,E265
exclude = migrations

View file

Some files were not shown because too many files have changed in this diff Show more