CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-20 17:44:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Raphael Michel
2015-06-28 16:28:24 +02:00
parent 6ceb061205
commit e419b9a99d
2 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/development/goals.rst
View File

@@ -6,17 +6,27 @@ Pretix is a web software handling presale of event tickets.
Technical goals Technical goals
--------------- ---------------
* Python 3.4 features may be used, Python 3.2 is an absolute requirement * Python 3.4
* Use Django 1.7+ * Use Django 1.8+
* Be PEP-8 compliant * Be PEP-8 compliant
* Be fully internationalized, unicode and timezone aware * Be fully internationalized, unicode and timezone aware
* Use a fully documented and reproducible setup * Use a fully documented and reproducible setup
* Be fully tested by both unit and behaviour tests * Be fully tested by unit tests
* Use LessCSS * Use LessCSS
Feature goals Feature goals
------------- -------------
Next goals
^^^^^^^^^^
* HBCI support
* There is the possibility to send out payment reminders
* The user can download the ticket in PDF form, for which the organizer can upload and customize a template without ever touching a line of code
* The system provides a variety of statistics
* The system provices export methods for multiple cashdesk/ticket validation systems
Achieved goals
^^^^^^^^^^^^^^
* One pretix software installation has to cope with multiple events by multiple organizers * One pretix software installation has to cope with multiple events by multiple organizers
* There is no code access necessary to create a new event * There is no code access necessary to create a new event
* Pretix is abstract in many ways to adopt to as much events as possible. * Pretix is abstract in many ways to adopt to as much events as possible.
@@ -27,12 +37,8 @@ Feature goals
* Items can require additional user input (like attendee names) * Items can require additional user input (like attendee names)
* The software is not only user, but also organizer- and admin-friendly and provides a beautiful and time-saving interface for all admin jobs * The software is not only user, but also organizer- and admin-friendly and provides a beautiful and time-saving interface for all admin jobs
* The software is able to import bank data, at least using CSV files with support for MT940 or later even HBCI * The software is able to import bank data, at least using CSV files with support for MT940
* There is the possibility to add more payment methods later, such as credit card payment, PayPal or even cash * There is the possibility to add more payment methods later, such as credit card payment, PayPal or even cash
* There is a flexible concept of payment goals which works well together with the restriction framework mentioned above * There is a flexible concept of payment goals which works well together with the restriction framework mentioned above
* There is the possibility to send out payment reminders
* There is the possibility to cancel orders * There is the possibility to cancel orders
* There is the possibility of one user submitting multiple orders * There is the possibility of one user submitting multiple orders
* The user can download the ticket in PDF form, for which the organizer can upload and customize a template without ever touching a line of code
* The system provides a variety of statistics
* The system provices export methods for multiple cashdesk/ticket validation systems

9
doc/development/setup.rst
View File

@@ -68,15 +68,14 @@ and head to http://localhost:8000/
Code checks and unit tests Code checks and unit tests
^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^
Before you check in your code into git, always run:: Before you check in your code into git, always run the static checkers and unit tests::
flake8 . flake8 .
python manage.py validate python manage.py validate
python manage.py test py.test
to check for syntax, style and other errors. The ``flake8`` command by default is a bit The ``flake8`` command by default is a bit stricter than what we really enforce, but we do enforce that all commits
stricter than what we really enforce, but we do enforce that all commits produce no output produce no output from::
from::
flake8 --ignore=E123,E128,F403,F401,N802,W503 . flake8 --ignore=E123,E128,F403,F401,N802,W503 .