FOSSASIA‘s Open Event Server is the REST API backend for the event management platform, Open Event. Here, the event organizers can create their events, add tickets for it and manage all aspects from the schedule to the speakers. Also, once he/she makes his event public, others can view it and buy tickets if interested.
The organizer can see all the sessions in a very detailed view in the event management dashboard. He can see the statuses of all the sessions. The possible statuses are pending, accepted, confirmed and rejected. He/she can take actions such as accepting/rejecting the sessions.
If the organizer wants to download the list of all the sessions as a CSV file, he or she can do it very easily by simply clicking on the Export As CSV button in the top right-hand corner.
Let us see how this is done on the server.
Server side – generating the Sessions CSV file
Here we will be using the csv package provided by python for writing the csv file.
import csv
- We define a method export_sessions_csv which takes the sessions to be exported as a CSV file as the argument.
- Next, we define the headers of the CSV file. It is the first row of the CSV file.
def export_sessions_csv(sessions): headers = ['Session Title', 'Session Speakers', 'Session Track', 'Session Abstract', 'Created At', 'Email Sent']
- A list is defined called rows. This contains the rows of the CSV file. As mentioned earlier, headers is the first row.
rows = [headers]
- We iterate over each session in sessions and form a row for that session by separating the values of each of the columns by a comma. Here, every row is one session.
- As a session can contain multiple speakers we iterate over each speaker for that particular session and append each speaker to a string. ‘;’ is used as a delimiter. This string is then added to the row.
- The newly formed row is added to the rows list.
for session in sessions: if not session.deleted_at: column = [session.title + ' (' + session.state + ')' if session.title else ''] if session.speakers: in_session = '' for speaker in session.speakers: if speaker.name: in_session += (speaker.name + '; ') column.append(in_session[:-2]) else: column.append('') column.append(session.track.name if session.track and session.track.name else '') column.append(strip_tags(session.short_abstract) if session.short_abstract else '') column.append(session.created_at if session.created_at else '') column.append('Yes' if session.is_mail_sent else 'No') rows.append(column)
- rows contains the contents of the CSV file and hence it is returned.
return rows
- We iterate over each item of rows and write it to the CSV file using the methods provided by the csv package.
writer = csv.writer(temp_file) from app.api.helpers.csv_jobs_util import export_sessions_csv content = export_sessions_csv(sessions) for row in content: writer.writerow(row)
Obtaining the Sessions CSV file:
Firstly, we have an API endpoint which starts the task on the server.
GET - /v1/events/{event_identifier}/export/sessions/csv
Here, event_identifier is the unique ID of the event. This endpoint starts a celery task on the server to export the sessions of the event as a CSV file. It returns the URL of the task to get the status of the export task. A sample response is as follows:
{ "task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a" }
The user can go to the above-returned URL and check the status of his/her Celery task. If the task completed successfully he/she will get the download URL. The endpoint to check the status of the task is:
and the corresponding response from the server –
{ "result": { "download_url": "/v1/events/1/exports/http://localhost/static/media/exports/1/zip/OGpMM0w2RH/event1.zip" }, "state": "SUCCESS" }
The file can be downloaded from the above-mentioned URL.