Welcome to Tarrab.me Server’s documentation!

Contents:

Commons module

Commons Models

class commons.models.CommonModel(*args, **kwargs)[source]

Bases: django.db.models.base.Model

creation_date
Creation datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
modified_date
Modified datetime

Type: django.db.models.fields.DateTimeField

Sets now on each updates.
Date (with time)
created_by
Created by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
modified_by
Modified by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
class Meta[source]

Bases: builtins.object

abstract = False
CommonModel.created_by
CommonModel.get_next_by_creation_date(*moreargs, **morekwargs)
CommonModel.get_next_by_modified_date(*moreargs, **morekwargs)
CommonModel.get_previous_by_creation_date(*moreargs, **morekwargs)
CommonModel.get_previous_by_modified_date(*moreargs, **morekwargs)
CommonModel.modified_by

Commons AdminForms

class commons.adminForms.CommonAdminForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None)[source]

Bases: django.forms.models.ModelForm

class Meta[source]

Bases: builtins.object

exclude = ('created_by', 'modified_by')
CommonAdminForm.base_fields = OrderedDict()
CommonAdminForm.declared_fields = OrderedDict()
CommonAdminForm.media

Commons Admin

class commons.admin.CommonAdmin(model, admin_site)[source]

Bases: django.contrib.admin.options.ModelAdmin

class Meta[source]

Bases: builtins.object

exclude = ('created_by', 'modified_by')
CommonAdmin.media
CommonAdmin.save_model(request, obj, form, change)[source]

Events module

Events Models

class events.models.Event(*args, **kwargs)[source]

Bases: commons.models.CommonModel

Event(id, creation_date, modified_date, created_by_id, modified_by_id, name, commercial_name, prefix, start_date, end_date, active, description)

id
Id

Type: django.db.models.fields.AutoField

Integer
creation_date
Creation datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
modified_date
Modified datetime

Type: django.db.models.fields.DateTimeField

Sets now on each updates.
Date (with time)
created_by
Created by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
modified_by
Modified by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
name
Name

Type: django.db.models.fields.CharField

Maximum length: 100
String (up to 100)
commercial_name
Commercial name

Type: django.db.models.fields.CharField

Maximum length: 150
String (up to 150)
prefix
Prefix

Type: django.db.models.fields.CharField

Maximum length: 4
String (up to 4)
start_date
Start datetime

Type: django.db.models.fields.DateTimeField

Date (with time)
end_date
End datetime

Type: django.db.models.fields.DateTimeField

Date (with time)
active
Active

Type: django.db.models.fields.BooleanField

Default value: False
Boolean (either true or false)
description
Description

Type: django.db.models.fields.TextField

Default value:
Text
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Event.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Event.created_by
Event.get_next_by_creation_date(*moreargs, **morekwargs)
Event.get_next_by_end_date(*moreargs, **morekwargs)
Event.get_next_by_modified_date(*moreargs, **morekwargs)
Event.get_next_by_start_date(*moreargs, **morekwargs)
Event.get_previous_by_creation_date(*moreargs, **morekwargs)
Event.get_previous_by_end_date(*moreargs, **morekwargs)
Event.get_previous_by_modified_date(*moreargs, **morekwargs)
Event.get_previous_by_start_date(*moreargs, **morekwargs)
Event.modified_by
Event.objects = <django.db.models.manager.Manager object at 0x7fa0af101080>
class events.models.EventSerializer(instance=None, data=None, **kwargs)[source]

Bases: rest_framework.serializers.ModelSerializer

class Meta[source]

Bases: builtins.object

model

alias of Event

Events AdminForms

class events.adminForms.EventAdminForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None)[source]

Bases: commons.adminForms.CommonAdminForm

class Meta[source]

Bases: commons.adminForms.Meta

model

alias of Event

EventAdminForm.base_fields = OrderedDict([('name', <django.forms.fields.CharField object at 0x7fa0af08e518>), ('commercial_name', <django.forms.fields.CharField object at 0x7fa0af1197b8>), ('prefix', <django.forms.fields.CharField object at 0x7fa0af0a10b8>), ('start_date', <django.forms.fields.DateTimeField object at 0x7fa0af0a11d0>), ('end_date', <django.forms.fields.DateTimeField object at 0x7fa0af0a1240>), ('active', <django.forms.fields.BooleanField object at 0x7fa0af0a12e8>), ('description', <django.forms.fields.CharField object at 0x7fa0af0a1358>)])
EventAdminForm.declared_fields = OrderedDict()
EventAdminForm.media

Events Admin

class events.admin.EventAdmin(model, admin_site)[source]

Bases: commons.admin.CommonAdmin

form

alias of EventAdminForm

list_display = ('name', 'start_date', 'active', 'created_by')
list_filter = ['active', 'start_date', 'created_by']
media
search_fields = ['name', 'commercial_name']

Tickets module

Tickets Models

class tickets.models.AbstractAttempt(*args, **kwargs)[source]

Bases: django.db.models.base.Model

date
Attempt datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
user
User

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
class Meta[source]

Bases: builtins.object

abstract = False
AbstractAttempt.get_next_by_date(*moreargs, **morekwargs)
AbstractAttempt.get_previous_by_date(*moreargs, **morekwargs)
AbstractAttempt.save(force_insert=False, force_update=False, using=None, request=None)[source]
AbstractAttempt.user
class tickets.models.Attempt(*args, **kwargs)[source]

Bases: tickets.models.AbstractAttempt

Attempt(id, date, user_id, code, ticket_code_id, success)

id
Id

Type: django.db.models.fields.AutoField

Integer
date
Attempt datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
user
User

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
code
Code

Type: django.db.models.fields.CharField

Maximum length: 60
String (up to 60)
ticket_code
Ticket code

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
success
Using success

Type: django.db.models.fields.BooleanField

Default value: False
Boolean (either true or false)
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Attempt.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Attempt.get_next_by_date(*moreargs, **morekwargs)
Attempt.get_previous_by_date(*moreargs, **morekwargs)
Attempt.objects = <django.db.models.manager.Manager object at 0x7fa0af05dc50>
Attempt.ticket_code
Attempt.user
class tickets.models.AttemptListItemSerializer(instance=None, data=None, **kwargs)[source]

Bases: rest_framework.serializers.ModelSerializer

class Meta[source]

Bases: builtins.object

fields = ('id', 'user', 'success', 'date')
model

alias of Attempt

class tickets.models.AttemptSerializer(instance=None, data=None, **kwargs)[source]

Bases: rest_framework.serializers.ModelSerializer

class Meta[source]

Bases: builtins.object

model

alias of Attempt

class tickets.models.FakeAttempt(*args, **kwargs)[source]

Bases: tickets.models.AbstractAttempt

FakeAttempt(id, date, user_id, code)

id
Id

Type: django.db.models.fields.AutoField

Integer
date
Attempt datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
user
User

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
code
Code

Type: django.db.models.fields.CharField

Maximum length: 90
String (up to 90)
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception FakeAttempt.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

FakeAttempt.get_next_by_date(*moreargs, **morekwargs)
FakeAttempt.get_previous_by_date(*moreargs, **morekwargs)
FakeAttempt.objects = <django.db.models.manager.Manager object at 0x7fa0af064048>
FakeAttempt.user
class tickets.models.TicketCode(*args, **kwargs)[source]

Bases: commons.models.CommonModel

TicketCode(id, creation_date, modified_date, created_by_id, modified_by_id, code, ticket_pack_id, status, ticket_number, external_id, external_customer_name, external_fiscal_number, external_locator)

id
Id

Type: django.db.models.fields.AutoField

Integer
creation_date
Creation datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
modified_date
Modified datetime

Type: django.db.models.fields.DateTimeField

Sets now on each updates.
Date (with time)
created_by
Created by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
modified_by
Modified by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
code
Code

Type: django.db.models.fields.CharField

Maximum length: 60
String (up to 60)
ticket_pack
Ticket pack

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
status
Status

Type: django.db.models.fields.CharField

Maximum length: 2
Choices:
  • NW -> New
  • US -> Used
  • DS -> Disabled

Default value: NW

String (up to 2)
ticket_number
Ticket number

Type: django.db.models.fields.PositiveIntegerField

Positive integer
external_id
External id

Type: django.db.models.fields.CharField

Maximum length: 50
String (up to 50)
external_customer_name
External customer name

Type: django.db.models.fields.CharField

Maximum length: 200
String (up to 200)
external_fiscal_number
External fiscal number

Type: django.db.models.fields.CharField

Maximum length: 20
String (up to 20)
external_locator
External locator

Type: django.db.models.fields.CharField

Maximum length: 40
String (up to 40)
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception TicketCode.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

TicketCode.TICKET_CODE_STATUS = (('NW', 'New'), ('US', 'Used'), ('DS', 'Disabled'))
TicketCode.TICKET_CODE_STATUS_DISABLED = 'DS'
TicketCode.TICKET_CODE_STATUS_NEW = 'NW'
TicketCode.TICKET_CODE_STATUS_USED = 'US'
TicketCode.attempt_count()[source]
TicketCode.attempt_list
TicketCode.created_by
TicketCode.event()[source]
TicketCode.get_next_by_creation_date(*moreargs, **morekwargs)
TicketCode.get_next_by_modified_date(*moreargs, **morekwargs)
TicketCode.get_previous_by_creation_date(*moreargs, **morekwargs)
TicketCode.get_previous_by_modified_date(*moreargs, **morekwargs)
TicketCode.get_status_display(*moreargs, **morekwargs)
TicketCode.make_attempt(user)[source]
TicketCode.modified_by
TicketCode.objects = <tickets.models.TicketCodeManager object at 0x7fa0af0a6f98>
TicketCode.ticket_pack
class tickets.models.TicketCodeManager[source]

Bases: django.db.models.manager.Manager

get_for_attempt(code)[source]
make_attempt(code, user)[source]
class tickets.models.TicketCodeSerializer(instance=None, data=None, **kwargs)[source]

Bases: rest_framework.serializers.ModelSerializer

class Meta[source]

Bases: builtins.object

model

alias of TicketCode

class tickets.models.TicketPack(*args, **kwargs)[source]

Bases: commons.models.CommonModel

TicketPack(id, creation_date, modified_date, created_by_id, modified_by_id, name, prefix, event_id)

id
Id

Type: django.db.models.fields.AutoField

Integer
creation_date
Creation datetime

Type: django.db.models.fields.DateTimeField

Sets now when create.
Date (with time)
modified_date
Modified datetime

Type: django.db.models.fields.DateTimeField

Sets now on each updates.
Date (with time)
created_by
Created by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
modified_by
Modified by

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
name
Name

Type: django.db.models.fields.CharField

Maximum length: 50
String (up to 50)
prefix
Prefix

Type: django.db.models.fields.CharField

Maximum length: 2
String (up to 2)
event
Event

Type: django.db.models.fields.related.ForeignKey

Foreign key (type determined by related field)
exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception TicketPack.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

TicketPack.created_by
TicketPack.event
TicketPack.get_next_by_creation_date(*moreargs, **morekwargs)
TicketPack.get_next_by_modified_date(*moreargs, **morekwargs)
TicketPack.get_prefix()[source]
TicketPack.get_previous_by_creation_date(*moreargs, **morekwargs)
TicketPack.get_previous_by_modified_date(*moreargs, **morekwargs)
TicketPack.get_ticket_count()[source]
TicketPack.modified_by
TicketPack.objects = <django.db.models.manager.Manager object at 0x7fa0af0a68d0>
TicketPack.ticket_codes
class tickets.models.TicketPackSerializer(instance=None, data=None, **kwargs)[source]

Bases: rest_framework.serializers.ModelSerializer

class Meta[source]

Bases: builtins.object

model

alias of TicketPack

Tickets AdminForms

class tickets.adminForms.TicketPackAdminForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None)[source]

Bases: commons.adminForms.CommonAdminForm

class Meta[source]

Bases: commons.adminForms.Meta

model

alias of TicketPack

TicketPackAdminForm.base_fields = OrderedDict([('name', <django.forms.fields.CharField object at 0x7fa0af0b4cf8>), ('prefix', <django.forms.fields.CharField object at 0x7fa0af0b4ba8>), ('event', <django.forms.models.ModelChoiceField object at 0x7fa0af09acf8>), ('upload_file_field', <django.forms.fields.FileField object at 0x7fa0aefbe080>), ('upload_file_format_field', <django.forms.fields.ChoiceField object at 0x7fa0aefbe710>), ('generation_count', <django.forms.fields.IntegerField object at 0x7fa0af0a69b0>), ('code_length', <django.forms.fields.IntegerField object at 0x7fa0aefd12b0>)])
TicketPackAdminForm.declared_fields = OrderedDict([('upload_file_field', <django.forms.fields.FileField object at 0x7fa0aefbe080>), ('upload_file_format_field', <django.forms.fields.ChoiceField object at 0x7fa0aefbe710>), ('generation_count', <django.forms.fields.IntegerField object at 0x7fa0af0a69b0>), ('code_length', <django.forms.fields.IntegerField object at 0x7fa0aefd12b0>)])
TicketPackAdminForm.media

Tickets Admin

class tickets.admin.TicketCodeAdmin(model, admin_site)[source]

Bases: commons.admin.CommonAdmin

actions = ['disable', 'remove_attempts', 'mark_as_used', 'mark_as_new', 'make_attempt', <tickets.exporters.DefaultTicketWithAttemptsExporter object at 0x7fa0aefb2518>, <tickets.exporters.DefaultTicketExporter object at 0x7fa0aefb2438>]
disable(request, queryset)[source]
form

alias of TicketPackAdminForm

list_display = ['code', 'ticket_number', 'status', 'ticket_pack', 'attempt_count', 'event', 'external_customer_name', 'external_fiscal_number', 'external_locator', 'external_id']
list_filter = ['ticket_pack__event', 'status', 'ticket_pack']
list_per_page = 500
make_attempt(request, queryset)[source]
mark_as_new(request, queryset)[source]
mark_as_used(request, queryset)[source]
media
remove_attempts(request, queryset)[source]
search_fields = ['code', 'ticket_number', 'external_locator', 'external_id']
class tickets.admin.TicketPackAdmin(model, admin_site)[source]

Bases: django.contrib.admin.options.ModelAdmin

actions = ['put_ticket_number', <tickets.exporters.DefaultTicketPackExporter object at 0x7fa0aefb2630>, <tickets.exporters.DefaultTicketPackWithAttemptsExporter object at 0x7fa0aefb2668>]
fieldsets = ((None, {'fields': ('name', 'event', 'prefix')}), ('Generate ticket codes', {'classes': ('collapse',), 'fields': ('generation_count', 'code_length')}), ('Upload ticket codes', {'classes': ('collapse',), 'fields': ('upload_file_field', 'upload_file_format_field')}))
form

alias of TicketPackAdminForm

generate_codes(ticket_pack, request, count, length=14)[source]
list_display = ['__str__', 'event', 'get_ticket_count']
list_filter = ['event']
media
process_upload_field(ticket_pack, request, up_file, importer)[source]
put_ticket_number(request, queryset)[source]
save_model(request, obj, form, change)[source]

Tickets Exporters

class tickets.exporters.BaseExporter[source]

Bases: builtins.object

create_response()[source]
get_tickets(queryset)[source]
mime_type = 'text/csv'
short_description = 'Base class for exporters'
write_data(response, tickets)[source]
class tickets.exporters.BaseTicketExporter[source]

Bases: tickets.exporters.BaseExporter

get_tickets(queryset)[source]
short_description = 'Base class for ticket exporters'
class tickets.exporters.BaseTicketPackExporter[source]

Bases: tickets.exporters.BaseExporter

get_tickets(queryset)[source]
short_description = 'Base class for ticket pack exporters'
class tickets.exporters.DefaultTicketExporter[source]

Bases: tickets.exporters.BaseTicketExporter

create_writer(response)[source]
short_description = 'Export selected tickets as CSV file'
write_data(response, tickets)[source]
write_item(writer, item)[source]
class tickets.exporters.DefaultTicketPackExporter[source]

Bases: tickets.exporters.BaseTicketPackExporter, tickets.exporters.DefaultTicketExporter

short_description = 'Export selected ticket packs as CSV file'
class tickets.exporters.DefaultTicketPackWithAttemptsExporter[source]

Bases: tickets.exporters.BaseTicketPackExporter, tickets.exporters.DefaultTicketWithAttemptsExporter

short_description = 'Export selected ticket packs with attempts as CSV file'
class tickets.exporters.DefaultTicketWithAttemptsExporter[source]

Bases: tickets.exporters.DefaultTicketExporter

short_description = 'Export selected tickets with attempts as CSV file'
write_item(writer, item)[source]
class tickets.exporters.ExporterManager[source]

Bases: builtins.object

register(exporter_cls)[source]
unregister(exporter_cls)[source]

Tickets Importers

class tickets.importers.AtrapaloImporter(csv_file=None)[source]

Bases: tickets.importers.BaseImporter

label = 'Atrapalo'
map_to_ticket(ticket, row)[source]
class tickets.importers.BaseImporter(csv_file=None)[source]

Bases: builtins.object

create_reader(csv_file)[source]
iter_tickets()[source]
label = 'Base importer'
map_to_ticket(ticket, row)[source]
class tickets.importers.DefaultImporter(csv_file=None)[source]

Bases: tickets.importers.BaseImporter

label = 'Tarrab.me'
class tickets.importers.ImporterManager[source]

Bases: builtins.object

create_importer(name, csv_file)[source]
get_select_options()[source]
register(name, importer_cls)[source]
unregister(name)[source]
class tickets.importers.ProductesDeLaTerraImporter(csv_file=None)[source]

Bases: tickets.importers.BaseImporter

label = 'Productes de la terra'
map_to_ticket(ticket, row)[source]
class tickets.importers.TicketeaImporter(csv_file=None)[source]

Bases: tickets.importers.BaseImporter

label = 'Ticketea'
map_to_ticket(ticket, row)[source]

Tickets Helpers

tickets.helpers.create_code(length=18, prefix='')[source]
tickets.helpers.luhn_digit(code)[source]

Users module

Users Models

class users.models.UserSerializer(instance=None, data=None, **kwargs)[source]

Bases: rest_framework.serializers.HyperlinkedModelSerializer

class Meta[source]

Bases: builtins.object

fields = ('id', 'username', 'first_name')
model

alias of User

Indices and tables