djangoldp-energiepartagee

djangoldp_energiepartagee

Installation

How to install the project locally

1- create virtual environement py -m venv venv

2- activate venv venv\Scripts\activate.bat

3- update pip & wheel py -m pip install -U pip wheel

4- install sib-manager py -m pip install -U sib-manager

5- launch the startproject command sib startproject energiepartagee_server

6- install server => go into energiepartagee_server folder sib install server

7- create superuser py manage.py createsuperuser

8- add virtual link with the djangoldp_energiepartagee package : mklink /D [LINK] [TARGET] mklink /D [...]\energiepartage_server\djangoldp_energiepartagee [...]\djangoldp_energiepartagee\djangoldp_energiepartagee =><!> [LINK] : Link to the "folder" where the target will be found

9- add the package in the package.yml file

10- run migration and migrate py manage.py makemigrations djangoldp_energiepartagee (for the first time, then py manage.py makemigrations will be enough in case ogf modifications of the package) py manage.py migrate

11- runserver py manage.py runserver

Custom Commands

With djangoldp_energiepartagee installed as an app, you will be able to run:

python manage.py create_annual_contributions

This command calculates the contribution for every actor in the database and creates a Contribution for each. The amount is calculated following an algorithm which can be found in the Actor model (Actor.get_next_contribution_amount). A contribution will not be added for any actors which have already paid a contribution in the same year. Use the -F option to override this, creating one contribution for every actor in the databae.

Enable the context preprocessors

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                ...
                'djangoldp_energiepartagee.context_processors.is_amorce',
            ],
        },
    },
]

Or, with SIB Platform:

apps:
  hosts:
    xxx:
      services:
        context:
          processor: djangoldp_energiepartagee.context_processors.is_amorce

Disable AMORCE Specific routines

In your settings.yml:

server:
  IS_AMORCE: False