Miroir du site de l'AE UTBM https://ae.utbm.fr
Go to file
Skia 71f9e359c0 Merge branch 'forum' into 'master'
Remove ambiguity for topic creation in a category

See merge request !85
2017-06-14 08:35:17 +02:00
accounting Format accounting 2017-06-13 09:48:24 +02:00
api Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
club Format club 2017-06-13 09:48:24 +02:00
com Format com 2017-06-13 09:48:24 +02:00
core Format core 2017-06-13 10:04:13 +02:00
counter Format counter 2017-06-13 10:04:13 +02:00
doc Add Eboutic user guides and reference examples 2017-05-02 18:23:46 +02:00
eboutic Format eboutic 2017-06-13 10:04:13 +02:00
election Other line fix 2017-06-07 19:36:55 +02:00
forum Remove ambiguity 2017-06-14 00:47:16 +02:00
launderette Format launderette 2017-06-13 10:04:13 +02:00
locale/fr/LC_MESSAGES trombi: Many UI/UX improvements 2017-06-13 00:23:56 +02:00
rootplace Add subscriptions stats 2017-06-06 22:03:56 +02:00
sas fix merging 2017-06-13 10:49:11 +02:00
sith Format sith 2017-06-13 10:04:13 +02:00
stock Add header to stock files 2017-04-25 16:17:04 +02:00
subscription Format subscription 2017-06-13 10:07:57 +02:00
trombi Fix import in trombi views 2017-06-13 11:45:17 +02:00
.gitignore Don't ignore */static 2016-12-26 01:59:54 +01:00
.gitlab-ci.yml Fix CI 2016-11-08 19:27:04 +01:00
CONTRIBUTING.md Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
Doxyfile Update Doxyfile 2016-06-22 14:52:53 +02:00
LICENSE Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
LICENSE.old Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
manage.py Apply GPLv3 to Sith, and add header to every concerned file 2017-04-24 17:51:12 +02:00
migrate.py Fix images and links parsing in doku_to_markdown 2017-05-31 19:13:43 +02:00
README.md Doc for scss 2017-05-10 11:13:49 +02:00
requirements.txt New lite home made scss processor 2017-05-10 10:49:34 +02:00
TODO.md Add basic refill support 2016-06-26 20:07:29 +02:00

Sith AE

Get started

To start working on the project, just run the following commands:

git clone https://ae-dev.utbm.fr/ae/Sith.git
cd Sith
virtualenv --clear --python=python3 env
source env/bin/activate
pip install -r requirements.txt
./manage.py setup

To start the simple development server, just run python3 manage.py runserver

Generating documentation

There is a Doxyfile at the root of the project, meaning that if you have Doxygen, you can run doxygen Doxyfile to generate a complete HTML documentation that will be available in the ./doc/html/ folder.

Dependencies:

See requirements.txt

You may need to install some dev libraries like libmysqlclient-dev, libssl-dev, libjpeg-dev, or zlib1g-dev to install all the requiered dependancies with pip. You may also need mysql-client. Don't also forget python3-dev if you don't have it already.

You can check all of them with:

sudo apt install libmysqlclient-dev libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev

The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example)

Collecting statics for production:

We use scss in the project. In development environment (DEBUG=True), scss is compiled every time the file is needed. For production, it assumes you have already compiled every files and to do so, you need to use the following commands :

./manage.py collectstatic # To collect statics
./manage.py compilestatic # To compile scss in those statics

Misc about development

Controlling the rights

When you need to protect an object, there are three levels:

  • Editing the object properties
  • Editing the object various values
  • Viewing the object

Now you have many solutions in your model:

  • You can define a is_owned_by(self, user), a can_be_edited_by(self, user), and/or a can_be_viewed_by(self, user) method, each returning True is the user passed can edit/view the object, False otherwise.
    This allows you to make complex request when the group solution is not powerful enough.
    It's useful too when you want to define class-wide permissions, e.g. the club members, that are viewable only for Subscribers.
  • You can add an owner_group field, as a ForeignKey to Group. Second is an edit_groups field, as a ManyToMany to Group, and third is a view_groups, same as for edit.

Finally, when building a class based view, which is highly advised, you just have to inherit it from CanEditPropMixin, CanEditMixin, or CanViewMixin, which are located in core.views. Your view will then be protected using either the appropriate group fields, or the right method to check user permissions.

Counting the number of line of code

# apt install cloc
$ cloc --exclude-dir=doc,env .