dorsax / betterlyze

Fetches data from the betterplace.org API and will render charts which can then be used e.g. on a Website to display informations about a project.

betterlyze

Fetches data from the betterplace.org API and will render charts which can then be used e.g. on a Website to display informations about a project.

installation

This project requires python 3.9 or later!

Create a python virtual environment and activate it:

python -m venv 'venv'
source venv/bin/activate 

All requirements are in the standard requirements.txt. Installing them inside your virtual environment is easy:

python -m pip install -r requirements.txt

For database support like mysql (which is shipped with this project), you have to install the corresponding packages to your OS before installing the needed packages for django to successfully connect to your database.

cp betterlyze/betterlyze/template-settings.py betterlyze/betterlyze/settings.py

Edit the following settings:

• DEBUG = FALSE
• ALLOWED_HOSTS (insert the FQDN where the app should be published)
• DATABASES
• TIME_ZONE
• LANGUAGE_CODE

Then apply migrations:

python betterlyze/manage.py migrate

check, if the server would run:

python betterlyze/manage.py runserver

cron

In order to achieve regular fetching of new donations, add the following cronjob to your crontab. Please adjust the placeholders as needed:

*/5 * * * * username /path/to/project/venv/bin/python /path/to/project/betterlyze/manage.py runcrons 

betterlyze's Issues

Rethink urls

The current urls are nasty. Rethink:

• URL for comparison sheet
• URL for events

Refactoring of the database to use

SQLite >> MySQL

Add style to all

Currently the web interfaces look terrible. Choose a fine template with CSS and co already in place. The admin area can be ignored right now.

Decision on what visualization to use

https://dash.plotly.com/dash-core-components/graph

Future events won"t render

If an event has only donations from before it has started, the compare app won"t load anything.

Good looking site for Events

Ability to create, update or delete an event without access to admin. Must include a way to start a crawl, see when it was last fetched and some key infos about all donations about that event.

Add cron support

Adding a means of scheduled fetching in version 1 was done by adding a cron job for the crawler.py. As v2 is written in the Django framework, a better scheduling environment is needed. Trying out celery seems fitting the purpose although a bit overpowered.

Change front end time display

Currently displaying the times on /analyse/ is a bit wacky. It always shows in UTC instead of the current browser's timezone, which makes it hard to interprete for humans.

• make all elemnts aware of the browser's timezone
• make sure that performance won't be an issue

Comment everything in the dash app

The dash app is poorly documented as of now.

Production readiness

Ensure that by the end of October the app is fully production ready, meaning:

• Full WSGI support
• Full instructions on how to set up the app, including generating a config or writing a setup script
• Deamonization of Schedulers

Create a page to display the current state of active crawling

• implement celery
• create page and implement it in urls and views

Filter events based on permission

Make it so that some events can be filtered by giving them permissions to be only accessed by logged in users.

implement social login

The following things are desired to be implemented:

• Add Events
• Delete Events
• Edit Events
• Crawl Event
• Anonymize Event
• User Profile
• Login via Discord or Twitch