em1le/hyperion_assessment

Demo application (second task)

The application look up for files within dropbox root folder, store data from those files and create a chart to display how many times a user modifies its files.

Getting Started

You need to have a valid dropbox token to go to the next step

Prerequisites

1. Python 3.6
2. Virtualenvwrapper
3. Docker
4. Docker-compose

Docker is optional. If you do not want to use docker replace DATABASES in tracker/settings.py

Replace the following code:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': config('DB_NAME'),
        'USER': config('DB_USER'),
        'PASSWORD': config('DB_PASSWORD'),
        'HOST': config('DB_HOST')
    }
}

with this:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': config('DB_NAME'),
    }
}

Check the Prerequisites

The following commands must be type in your bash.

Check if Python 3.6 is installed:

python --version

If not follow this link

Now check that you have virtualenvwrapper installed:

virtualenvwrapper

If not:

sudo apt install virtualenvwrapper

optional

If docker and docker-compose are already installed on your local machine you can pass. If not follow this link

Installing

Clone the project

Firstly, we must copy the project

git clone git@github.com:em1le/hyperion_assessment.git

Secondly we must go into the directory of the app

cd second_task/

Set up virtualenvwrapper

Virtualenvwrapper is installed on you computer. Now we are going to create a virtualenv for the app.

To do so, type the following command:

mkvirtualenvwrapper tracker

then we need to install depencies in order to have a working application:

pip install -r requirements.txt

Now that you have set up your env and installed the requirements, go to the next step

Fire up docker-compose

This step is optional as you might not want to use docker.

If you want to use docker, be sure to be in the right directory:

pwd

The result is as follow:

/home/user/path_to/assessment/second_task

Then type the command to create a docker that will contains a postgres db:

sudo docker-compose -f docker-compose.yml up

Set up you dropbox token

Be ready, you are almost done with settings.

We need to know where we are so:

pwd

The result is as follow:

/home/user/path_to/assessment/second_task

Type:

cd tracker/

We are now in our django application

Open the .env file and change the line DROPBOX_TOKEN with yours

DROPBOX_TOKEN=your_dropbox_token

Run the migration command

Migrate the models to the database:

./manage.py migrate

Test if your app is ok

To be sure we can launch our app without doubts:

./manage.py check

From now you app should work without any problems.

How does it work?

You can check how many times a user modified its files in 3 ways:

1 - In running the django management command:

./manage.py check_filedata

2 - In creating a django crontab:

./manage.py crontab add

The settings of django crontab are available in django setting file

3 - Using the interface

Built With

• Django - The python framework used
• Chartit - module to create charts
• Django cron - module to create django cron

Things missing:

• lookup for dropbox root subfolders
• update files from the root subfolders
• better errors management