From e419b9a99dcba659e9232e009fb6529eba283386 Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Sun, 28 Jun 2015 16:28:24 +0200 Subject: [PATCH] Updated documentation --- doc/development/goals.rst | 22 ++++++++++++++-------- doc/development/setup.rst | 9 ++++----- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/doc/development/goals.rst b/doc/development/goals.rst index 49e23341f..35d8bd3f8 100644 --- a/doc/development/goals.rst +++ b/doc/development/goals.rst @@ -6,17 +6,27 @@ Pretix is a web software handling presale of event tickets. Technical goals --------------- -* Python 3.4 features may be used, Python 3.2 is an absolute requirement -* Use Django 1.7+ +* Python 3.4 +* Use Django 1.8+ * Be PEP-8 compliant * Be fully internationalized, unicode and timezone aware * Use a fully documented and reproducible setup -* Be fully tested by both unit and behaviour tests +* Be fully tested by unit tests * Use LessCSS 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 * 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. @@ -27,12 +37,8 @@ Feature goals * 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 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 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 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 diff --git a/doc/development/setup.rst b/doc/development/setup.rst index a0d04f36f..f9db3dc90 100644 --- a/doc/development/setup.rst +++ b/doc/development/setup.rst @@ -68,15 +68,14 @@ and head to http://localhost:8000/ 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 . 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 -stricter than what we really enforce, but we do enforce that all commits produce no output -from:: +The ``flake8`` command by default is a bit stricter than what we really enforce, but we do enforce that all commits +produce no output from:: flake8 --ignore=E123,E128,F403,F401,N802,W503 .