Restructure our python module. A lot.

This commit is contained in:
Raphael Michel
2015-02-14 17:55:13 +01:00
parent cf18f3e200
commit 077413f41c
117 changed files with 193 additions and 163 deletions
+2 -2
View File
@@ -55,7 +55,7 @@ example, taken from the time restriction module (see next chapter) as a template
name = 'pretixplugins.timerestriction'
verbose_name = _("Time restriction")
class TixlPluginMeta:
class PretixPluginMeta:
type = PluginType.RESTRICTION
name = _("Restriciton by time")
author = _("the pretix team")
@@ -70,7 +70,7 @@ example, taken from the time restriction module (see next chapter) as a template
default_app_config = 'pretixplugins.timerestriction.TimeRestrictionApp'
.. IMPORTANT::
You have to implement a ``TixlPluginMeta`` class like in the example to make your
You have to implement a ``PretixPluginMeta`` class like in the example to make your
plugin available to the users.
.. _signal dispatcher: https://docs.djangoproject.com/en/1.7/topics/signals/
+8 -8
View File
@@ -9,26 +9,26 @@ The components
The project pretix is split into several components. The main three of them are:
**pretixbase**
Tixlbase is the foundation below all other components. It is primarily
**pretix.base**
Pretixbase is the foundation below all other components. It is primarily
responsible for the data structures and database communication. It also hosts
several utilities which are used by multiple other components.
**pretixcontrol**
Tixlcontrol is the web-based backend software which allows organizers to
**pretix.control**
Pretixcontrol is the web-based backend software which allows organizers to
create and manage their events, items, orders and tickets.
**pretixpresale**
Tixlpresale is the ticket-shop itself, containing all the parts visible to the
**pretix.presale**
Pretixpresale is the ticket-shop itself, containing all the parts visible to the
end user.
Users and events
^^^^^^^^^^^^^^^^
Tixl is all about **events**, which are defined as something happening somewhere.
Pretix is all about **events**, which are defined as something happening somewhere.
Every Event is managed by the **organizer**, an abstract entity running the event.
Tixl is used by **users**. We want to enable global users who can just login into
Pretix is used by **users**. We want to enable global users who can just login into
pretix and buy tickets for as many events as they like but at the same time it
should be possible to create some kind of local user to have a temporary account
just to buy tickets for one single event.
+2 -2
View File
@@ -1,7 +1,7 @@
Development goals
=================
Tixl is a web software handling presale of event tickets.
Pretix is a web software handling presale of event tickets.
Technical goals
---------------
@@ -19,7 +19,7 @@ Feature goals
* One pretix software installation has to cope with multiple events by multiple organizers
* There is no code access necessary to create a new event
* Tixl is abstract in many ways to adopt to as much events as possible.
*Tixe is abstract in many ways to adopt to as much events as possible.
* Tickets are only an instance of an abstract model called items, such that the system can also sell e.g. merchandise
* An abstract concept of restriction is used to restrict the selling of tickets, for example by date, by number or by user permissions.
+22 -18
View File
@@ -7,22 +7,22 @@ Python source code
All the source code lives in ``src/``, which has several subdirectories.
pretix/
This directory contains the basic Django settings and URL routing.
This directory contains nearly all source code.
pretixbase/
This is the django app containing all the models and methods which are
essential to all of pretix's features.
base/
This is the django app containing all the models and methods which are
essential to all of pretix's features.
pretixcontrol/
This is the django app containing the frontend for organizers.
control/
This is the django app containing the frontend for organizers.
pretixpresale/
This is the django app containing the frontend for users buying tickets.
presale/
This is the django app containing the frontend for users buying tickets.
helpers/
Helpers contain a very few modules providing workarounds for low-level flaws in
Django or installed 3rd-party packages, like a filter to combine the ``lessc``
preprocessor with ``django-compressor``'s URL rewriting.
helpers/
Helpers contain a very few modules providing workarounds for low-level flaws in
Django or installed 3rd-party packages, like a filter to combine the ``lessc``
preprocessor with ``django-compressor``'s URL rewriting.
Language files
--------------
@@ -37,21 +37,25 @@ LESS source code
We use less as a preprocessor for CSS. Our own less code is built in the same
step as Bootstrap and FontAwesome, so their mixins etc. are fully available.
pretixcontrol
pretixcontrol has two main LESS files, ``pretixcontrol/static/pretixcontrol/less/main.less`` and
``pretixcontrol/static/pretixcontrol/less/auth.less``, importing everything else.
pretix.control
pretixcontrol has two main LESS files, ``pretix/control/static/pretixcontrol/less/main.less`` and
``pretix/control/static/pretixcontrol/less/auth.less``, importing everything else.
pretix.presale
pretixpresale has one main LESS files, ``pretix/control/static/pretix/presale/less/main.less``,
importing everything else.
3rd-party assets
^^^^^^^^^^^^^^^^
Bootstrap
Bootstrap lives as a git submodule at ``pretixbase/static/bootstrap/``
Bootstrap lives as a git submodule at ``pretix/base/static/bootstrap/``
Font Awesome
Font Awesome lives as a git submodule at ``pretixbase/static/fontawesome/``
Font Awesome lives as a git submodule at ``pretix/base/static/fontawesome/``
jQuery
jQuery lives as a single JavaScript file in ``pretixbase/static/jquery/js/``
jQuery lives as a single JavaScript file in ``pretix/base/static/jquery/js/``
jQuery plugin: Django formsets
Our own modified version of `django-formset-js`_ is available as an independent