PK ølEX])š š README.md[![Build Status](https://travis-ci.org/defivelo/db.svg?branch=master)](https://travis-ci.org/defivelo/db)
# L’Intranet Défi Vélo
Ce dépôt contient tout ce qui est nécessaire à faire tourner l’Intranet Défi Vélo.
Il a pour objectif de simplifier et améliorer la gestion des mois, sessions,
Qualifs, établissements, etc, et vise principalement à être utilisée par
les collaborateurs du Défi Vélo, aux différents échelons cantonaux et
inter-cantonaux.
## Local setup
1. Clone the project:
```
git clone --recursive git@gitlab.liip.ch:swing/defivelo/intranet
```
2. Open the file `docker-compose.override.example.yml` and follow the instructions in it
3. Run the command `INITIAL=1 docker-compose up`
This will start the containers and set up the initial data. To access the site,
follow the instructions in the `docker-compose.override.example.yml` file.
Note the `INITIAL` flag should not be set for subsequent container starts unless
you want to reset the database.
## Roles & permissions
After adding a new permission in `defivelo/roles.py`, run the following inside docker to apply them:
```
docker-compose exec backend ./manage.py sync_roles --reset_user_permissions
```
## Clone production database
Import DB
```shell
docker-compose exec backend fab prod import-db
```
Run any pending migrations
```shell
docker-compose exec backend ./manage.py migrate
```
Set all passwords to "password"
```shell
docker-compose exec backend ./manage.py set_fake_passwords
```
## Automated tests
To run backend tests and lint checks, run `scripts/run_tests.sh` in the `backend` container:
* `docker-compose exec backend scripts/run_tests.sh`
* or `docker-compose run --rm backend scripts/run_tests.sh` if the `backend` service is not already running
CLI arguments are forwarded to `pytest`.
For example, running tests with `scripts/run_tests.sh defivelo --reuse-db` avoids
re-creating the database from scratch on each run.
PK ølEXÞ•›¥ ¥ pyproject.toml[tool.black]
line-length = 88
target-version = ['py37']
include = '\.pyi?$'
exclude = '''
(
\..*/
|/node_modules
|/virtualization
|migrations/
)
'''
PK ølEX™<¶ø Makefile.DEFAULT_GOAL := help
REQUIREMENTS_DIR = requirements
reqbases = $(wildcard $(REQUIREMENTS_DIR)/*.in)
objects = $(patsubst %.in,%.txt,$(reqbases))
$(REQUIREMENTS_DIR)/%.txt: $(REQUIREMENTS_DIR)/%.in $(reqbases)
pip-compile $<
.PHONY: requirements
requirements: $(objects) ## Compile requirements with pip-compile
.PHONY: upgrade-requirements
upgrade-requirements: ## Upgrade and compile requirements with pip-compile --upgrade
for file in $(REQUIREMENTS_DIR)/*.in; do \
pip-compile --upgrade $$file; \
done
.PHONY: sync-requirements
sync-requirements: ## Install development python dependencies and clean dangling dependencies from environment
pip-sync $(REQUIREMENTS_DIR)/dev.txt
.PHONY: translations
translations: ## Regenerate .po files with ./manage.py makemessages
./manage.py makemessages -a -i "requirements/*" -i "virtualization/*"
.PHONY: compile-translations
compile-translations: ## Compile .po files with ./manage.py compilemessages
./manage.py compilemessages -l fr -l de
.PHONY: format
format: # Fix some linting issues in the project
black apps defivelo fabfile.py
isort apps defivelo fabfile.py
.PHONY: lint
lint: # Show linting issues in the project
flake8 apps defivelo fabfile.py
.PHONY: help
help: ## Display this help
@grep -E '^[.a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort -k 1,1 | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
PK ølEX7õÙo o .gitlab-ci.ymlinclude:
- project: 'liipops/django-hoster'
file: django-hosting.yml
ref: main
variables:
LIIPOPS_HOSTS: swing-defivelo-intranet.k8s.liip.ch
DJANGO_SETTINGS_MODULE: defivelo.settings.base
GUNICORN_APP_NAME: defivelo.wsgi
LIIP_DOCKER_PYTHON_VERSION: "3.11"
BASE_ADDITIONAL_APKS: sassc
HTTPD_RUN_COMPRESS: "true"
stages:
- test
- build
test:
stage: test
rules:
# Always run on default branch
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
# Always run on MRs
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
tags:
- docker-nonswiss-ok
image: &test_image 'python:3.11-bullseye'
services:
- name: postgres:15
alias: db
variables:
GIT_SUBMODULE_STRATEGY: recursive
DJANGO_SETTINGS_MODULE: defivelo.settings.test
DATABASE_URL: postgresql://postgres:postgres@db/postgres
POSTGRES_PASSWORD: postgres
PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
cache:
key: *test_image
paths:
- .cache/pip
before_script:
- apt-get update; apt-get --no-install-recommends -y install sassc
script:
- pip install -r requirements/test.txt
- |
bash -c "
echo -n 'Wait until the PostgreSQL server is ready .'
while ! (echo > /dev/tcp/db/5432) >/dev/null 2>&1; do
echo -n '.'
sleep 1
done
echo ' Ready!'
"
- ./scripts/run_tests.sh
PK ølEXI}§l” ”
entrypoint.sh#!/bin/bash
if [ ! -e "$VIRTUAL_ENV/bin" ]; then
echo "Creating virtualenv at \"$VIRTUAL_ENV\""
python -m venv "$VIRTUAL_ENV"
fi
if [ "$INITIAL" = "1" ]; then
if [ ! -e "requirements/dev.txt" ]; then
pip install pip-tools
pip-compile requirements/dev.in
fi
pip install -r requirements/dev.txt
if [ ! -e "requirements/test.txt" ]; then
pip-compile requirements/test.in
fi
# Wait for the db server to be ready, then run the migrate command
while ! (echo > /dev/tcp/db/5432) >/dev/null 2>&1; do echo -n '.'; sleep 1; done;
echo "Running migrations..."
./manage.py migrate
fi
exec "${@}"
PK ølEX;Õ .coveragerc[run]
source =
apps
defivelo
omit =
apps/*/migrations/*
*/tests/*
*/tests.py
*/conftest.py
defivelo/wsgi.py
defivelo/settings/*
PK ølEX_]ˆ• • .git-blame-ignore-revs# First run of black + isort on the whole project
22f25b1a357838c028ce5ea59ee2d21d7878a59f
# black (20.8b1)
1bbb864111bfff74195252d2cdd8eba0318e898b
PK ølEXÚ
ù
.editorconfigroot = true
[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
[Makefile]
indent_style = tab
[*.{js,json,scss,yml,html}]
indent_style = space
indent_size = 2
[*.py]
max_line_length = 88
PK ølEX•Xõr/ / setup.cfg[flake8]
max-line-length = 88
exclude= */migrations/, defivelo/settings/, virtualization/, manage.py, node_modules, .git
per-file-ignores =
*/__init__.py:F401,F403
defivelo/settings/*:F405,F403
# Code style is managed by Black anyway
ignore = E, W
[isort]
multi_line_output=3
include_trailing_comma=True
force_grid_wrap=0
use_parentheses=True
known_first_party = apps, defivelo
known_django = django
default_section = THIRDPARTY
line_length = 88
sections = FUTURE,STDLIB,DJANGO,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
skip = node_modules,migrations,virtualization/drifter,
[tool:pytest]
DJANGO_SETTINGS_MODULE = defivelo.settings.test
python_files = test*.py tests.py tests/*.py
norecursedirs = node_modules deployment .git virtualization
addopts = --cov=apps --cov=defivelo --cov-report=term --no-cov-on-fail
PK ølEXè[݆ ݆ COPYING GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license
for software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are
designed to take away your freedom to share and change the works. By
contrast, our General Public Licenses are intended to guarantee your
freedom to share and change all versions of a program--to make sure it
remains free software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public
License.
"Copyright" also means copyright-like laws that apply to other kinds
of works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further restriction,
you may remove that term. If a license document contains a further
restriction but permits relicensing or conveying under this License, you
may add to a covered work material governed by the terms of that license
document, provided that the further restriction does not survive such
relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have permission
to link or combine any covered work with a work licensed under version 3
of the GNU General Public License into a single combined work, and to
convey the resulting work. The terms of this License will continue to
apply to the part which is the covered work, but the work with which it is
combined will remain governed by version 3 of the GNU General Public
License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may differ
in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero
General Public License "or any later version" applies to it, you have
the option of following the terms and conditions either of that
numbered version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number
of the GNU Affero General Public License, you may choose any version
ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that
proxy's public statement of acceptance of a version permanently
authorizes you to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
.
PK ølEXs–ÔV ÔV
fabfile.pyimport functools
import inspect
import os
import random
import subprocess
import time
from datetime import datetime
from io import StringIO
from tempfile import NamedTemporaryFile
import dj_database_url
from dulwich import porcelain
from fabric import task
from fabric.connection import Connection
from invoke import Exit
from invoke.context import Context
from invoke.exceptions import UnexpectedExit
ENVIRONMENTS = {
"prod": {
"root": "/var/www/intranet.defi-velo.ch/prod/",
# "host": "wpy10809@onhp-python3.iron.bsa.oriented.ch:29992", # OLD
"host": "wpy10809@onhp-python2.iron.bsa.oriented.ch:29992", # NEW
"pid": "/run/uwsgi/app/intranet.defi-velo.ch/pid",
"ini": "/etc/uwsgi/apps-enabled/intranet.defi-velo.ch.ini",
"settings": {
"ALLOWED_HOSTS": "\n".join(["intranet.defi-velo.ch"]),
"MEDIA_URL": "/media/",
"STATIC_URL": "/static/",
"MEDIA_ROOT": "/var/www/intranet.defi-velo.ch/prod/media/",
"STATIC_ROOT": "/var/www/intranet.defi-velo.ch/prod/static/",
"SITE_DOMAIN": "intranet.defi-velo.ch",
"SASSC_BIN_PATH": "/var/www/intranet.defi-velo.ch/prod/venv/bin/pysassc",
"VIRTUAL_ENV": "/var/www/intranet.defi-velo.ch/prod/venv",
},
},
"staging": {
"root": "/var/www/intranet.defi-velo.ch/staging/",
# "host": "wpy10809@onhp-python3.iron.bsa.oriented.ch:29992", # OLD
"host": "wpy10809@onhp-python2.iron.bsa.oriented.ch:29992", # NEW
"pid": "/run/uwsgi/app/staging.intranet.defi-velo.ch/pid",
"ini": "/etc/uwsgi/apps-enabled/staging.intranet.defi-velo.ch.ini",
"requirements": "staging",
"settings": {
"ALLOWED_HOSTS": "\n".join(["staging.intranet.defi-velo.ch"]),
"MEDIA_URL": "/media/",
"STATIC_URL": "/static/",
"MEDIA_ROOT": "/var/www/intranet.defi-velo.ch/staging/media/",
"STATIC_ROOT": "/var/www/intranet.defi-velo.ch/staging/static/",
"SITE_DOMAIN": "staging.intranet.defi-velo.ch",
"SASSC_BIN_PATH": "/var/www/intranet.defi-velo.ch/staging/venv/bin/pysassc",
"VIRTUAL_ENV": "/var/www/intranet.defi-velo.ch/staging/venv",
"USE_DB_EMAIL_BACKEND": "1",
"DJANGO_SETTINGS_MODULE": "defivelo.settings.staging",
},
},
}
project_name = "defivelo"
project_name_verbose = "Intranet Défi Vélo"
PRODUCTION_DB_NAME = "intranetdefiveloch001"
def remote(task_func):
"""
Decorate task functions to check for presence of a Connection instance in their context.
Also pass the Connection instance in argument for convenience.
"""
@functools.wraps(task_func)
def call_task_with_connection(ctx, *args, **kwargs):
if not hasattr(ctx, "conn"):
raise RuntimeError("Trying to run a remote task with no environment loaded")
return task_func(ctx, *args, **kwargs)
call_task_with_connection.__signature__ = inspect.signature(task_func)
return call_task_with_connection
def ensure_absolute_path(path):
if not os.path.isabs(path):
raise ValueError("{!r} is not an absolute path.".format(path))
class CustomConnection(Connection):
"""
Add helpers function on Connection
"""
@property
def site_root(self):
return self.config.root
@property
def project_root(self):
"""
Return the path to the root of the project on the remote server.
"""
return os.path.join(self.site_root, project_name)
@property
def venv_path(self):
return os.path.join(self.site_root, "venv")
@property
def envdir_path(self):
return os.path.join(self.project_root, "envdir")
@property
def backups_root(self):
"""
Return the path to the backups directory on the remote server.
"""
return os.path.join(self.site_root, "backups")
@property
def media_root(self):
"""
Return the path to the media directory on the remote server.
"""
try:
path = self.config.settings["MEDIA_ROOT"]
except KeyError:
return os.path.join(self.site_root, "media")
else:
ensure_absolute_path(path)
return path
@property
def static_root(self):
"""
Return the path to the static directory on the remote server.
"""
try:
path = self.config.settings["STATIC_ROOT"]
except KeyError:
return os.path.join(self.site_root, "static")
else:
ensure_absolute_path(path)
return path
def run_in_project_root(self, cmd, **kwargs):
"""
Run command after a cd to the project_root
"""
with self.cd(self.project_root):
return self.run(cmd, **kwargs)
def git(self, gitcmd, **kwargs):
"""
git from the project_root
"""
return self.run_in_project_root("git {}".format(gitcmd), **kwargs)
def run_in_venv(self, cmd, args, **run_kwargs):
"""
Binaries from the venv
"""
return self.run_in_project_root(
"{} {}".format(os.path.join(self.venv_path, "bin", cmd), args), **run_kwargs
)
def mk_venv(self, **run_kwargs):
"""
Create the venv
"""
with self.cd(self.site_root):
self.run("python3 -m venv venv", **run_kwargs)
def pip(self, args, **run_kwargs):
"""
pip from the venv, in the project_root
"""
return self.run_in_venv("pip", args, **run_kwargs)
def python(self, args, **run_kwargs):
"""
python from the venv, in the project_root
"""
return self.run_in_venv("python", args, **run_kwargs)
def manage_py(self, args, debug=False, **run_kwargs):
"""
manage.py with the python from the venv, in the project_root
"""
try:
env = {
"DJANGO_SETTINGS_MODULE": self.config.settings["DJANGO_SETTINGS_MODULE"]
}
except KeyError:
env = {}
if debug:
env["DEBUG"] = 1
return self.python("./manage.py {}".format(args), env=env, **run_kwargs)
def set_setting(self, name, value=None, force: bool = True):
"""
Set a setting in the environment directory, for use by Django
"""
envfile_path = os.path.join(self.envdir_path, name)
will_write = force
if not force:
try:
# Test that it does exist
self.run_in_project_root("test -r {}".format(envfile_path), hide=True)
except UnexpectedExit:
will_write = True
if will_write:
if value is None:
value = input("Value for {}: ".format(name))
# Convert booleans into values understood as such by Django
if isinstance(value, bool):
value = "1" if value else ""
self.put(StringIO("{}\n".format(value)), envfile_path)
def db_creds(self):
"""
Return DB dictionary of credentials from the DATABASE_URLÂ envdir var
"""
with self.cd(self.project_root):
db_credentials = self.run(
"cat envdir/DATABASE_URL", hide=True
).stdout.strip()
db_credentials_dict = dj_database_url.parse(db_credentials)
if not is_supported_db_engine(db_credentials_dict["ENGINE"]):
raise NotImplementedError(
"The dump_db task doesn't support the remote database engine"
)
return db_credentials_dict
def dump_db(self, destination):
"""
Dump the database to the given directory and return the path to the file created.
This creates a gzipped SQL file.
"""
db_credentials_dict = self.db_creds()
outfile = os.path.join(
destination, datetime.now().strftime("%Y-%m-%d_%H%M%S.sql.gz")
)
self.run(
"pg_dump -O -x -h '{host}' -U '{user}' '{db}'|gzip > {outfile}".format(
host=db_credentials_dict["HOST"],
user=db_credentials_dict["USER"],
db=db_credentials_dict["NAME"],
outfile=outfile,
),
env={"PGPASSWORD": db_credentials_dict["PASSWORD"].replace("$", "\$")},
)
return outfile
def drop_and_recreate_db(
self, production_db_name: str = PRODUCTION_DB_NAME, **kwargs
):
"""
Drop and recreate an empty DB for this environment
"""
db_creds = self.db_creds()
try:
confirmed = kwargs.pop("confirm_that_this_is_really_what_I_want")
except KeyError:
confirmed = False
if not confirmed:
raise Exit("You need to pass the righteous argument to proceed with this")
if db_creds["NAME"] == production_db_name:
raise Exit("This is the production DB, abort.")
self.run(
f"dropdb -h '{db_creds['HOST']}' -U '{db_creds['USER']}' '{db_creds['NAME']}'",
env={"PGPASSWORD": db_creds["PASSWORD"].replace("$", "\$")},
)
self.run(
f"createdb -h '{db_creds['HOST']}' -U '{db_creds['USER']}' '{db_creds['NAME']}'",
env={"PGPASSWORD": db_creds["PASSWORD"].replace("$", "\$")},
)
def restore_dump(self, db_dump_gz):
"""
Restore a gz DB dump to our database
"""
db_creds = self.db_creds()
self.run(
f"gunzip -c {db_dump_gz} | psql -h '{db_creds['HOST']}' -U '{db_creds['USER']}' '{db_creds['NAME']}'",
env={"PGPASSWORD": db_creds["PASSWORD"].replace("$", "\$")},
)
def create_structure(self):
"""
Create the basic directory structure on the remote server.
"""
command = " ".join(
[
"mkdir -p",
self.project_root,
self.backups_root,
self.static_root,
self.media_root,
]
)
self.run(command)
def clean_old_database_backups(self, nb_backups_to_keep):
"""
Remove old database backups from the system and keep `nb_backups_to_keep`.
"""
backups = self.ls(self.backups_root)
backups = sorted(backups, reverse=True)
if len(backups) > nb_backups_to_keep:
backups_to_delete = backups[nb_backups_to_keep:]
file_to_remove = [
os.path.join(self.backups_root, backup_to_delete)
for backup_to_delete in backups_to_delete
]
self.run('rm "%s"' % '" "'.join(file_to_remove))
print("%d backups deleted." % len(backups_to_delete))
else:
print("No backups to delete.")
def ls(self, path):
"""
Return the list of the files in the given directory, omitting . and ...
"""
with self.cd(path):
files = self.run("for i in *; do echo $i; done", hide=True).stdout.strip()
files_list = files.replace("\r", "").split("\n")
return files_list
def generate_secret_key():
"""
Generate a random secret key, suitable to be used as a SECRET_KEY setting.
"""
return "".join(
[
random.SystemRandom().choice(
"abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)"
)
for i in range(50)
]
)
def is_supported_db_engine(engine):
return engine in [
"django.db.backends.postgresql_psycopg2",
"django.db.backends.postgresql",
]
@task
@remote
def fetch_db(c, destination="."):
"""
Dump the database on the remote host and retrieve it locally.
The destination parameter controls where the dump should be stored locally.
"""
dump_path = c.conn.dump_db("~")
filename = os.path.basename(dump_path)
subprocess.run(
[
"scp",
"-P",
str(c.conn.port),
"{user}@{host}:{directory}".format(
user=c.conn.user, host=c.conn.host, directory=dump_path
),
destination,
]
)
c.conn.run("rm %s" % dump_path)
return os.path.join(destination, filename)
@task
@remote
def reset_db_from_prod(c):
"""
Restore the given database dump.
The dump must be a gzipped SQL dump. If the dump_file parameter is not set,
the database will be dumped and retrieved from the remote host.
"""
if not c.environment == "staging":
raise Exit(
"reset_db_from_prod can only be executed for the staging environment"
)
# Get PROD connection information
try:
prod_conf = ENVIRONMENTS["prod"]
except KeyError:
raise Exit("reset_db_from_prod needs to access the 'prod' environment")
# Â Do a pre-backup
c.conn.dump_db(c.conn.backups_root)
prod_ctx = Context(prod_conf)
prod_ctx.conn = CustomConnection(host=prod_conf["host"], inline_ssh_env=True)
prod_ctx.conn.config.load_overrides(prod_conf)
with NamedTemporaryFile() as local_transit_file:
# Handle the production part:
with prod_ctx.conn as conn:
# Dump the PROD DB
prod_dump_path = conn.dump_db("~")
# Download it here, assuming PROD and STAGING can be on complete different servers (it's not the case I know)
subprocess.run(
[
"scp",
"-P",
str(conn.port),
f"{conn.user}@{conn.host}:{prod_dump_path}",
local_transit_file.name,
]
)
# Delete the PROD dump from the server
conn.run("rm %s" % prod_dump_path)
# Now push to staging
with c.conn as conn:
# Put it to ~
subprocess.run(
[
"scp",
"-P",
str(conn.port),
local_transit_file.name,
f"{conn.user}@{conn.host}:{prod_dump_path}",
]
)
# OK. Now we have a prod backup on the staging environment. Proceed to restoring it
conn.drop_and_recreate_db(confirm_that_this_is_really_what_I_want=True)
# Restore the dump there
conn.restore_dump(prod_dump_path)
# Now remove the dump from the remote path too
conn.run("rm %s" % prod_dump_path)
# Run what's needed to bring the target env to a working state
dj_migrate_database(c)
dj_sync_roles(c)
c.conn.manage_py(
f'set_default_site --name "{project_name_verbose} ({c.environment})" --domain "{c.config.settings["SITE_DOMAIN"]}"'
)
c.conn.manage_py("set_fake_passwords", debug=True)
restart_uwsgi(c)
@task
@remote
def import_db(c, dump_file=None):
"""
Restore the given database dump.
The dump must be a gzipped SQL dump. If the dump_file parameter is not set,
the database will be dumped and retrieved from the remote host.
"""
db_credentials = os.environ.get("DATABASE_URL")
if not db_credentials:
with open("envdir/DATABASE_URL", "r") as db_credentials_file:
db_credentials = db_credentials_file.read()
db_credentials_dict = dj_database_url.parse(db_credentials)
if not is_supported_db_engine(db_credentials_dict["ENGINE"]):
raise NotImplementedError(
"The import_db task doesn't support your database engine"
)
if dump_file is None:
dump_file = fetch_db(c)
db_info = {
"host": db_credentials_dict["HOST"],
"user": db_credentials_dict["USER"],
"db": db_credentials_dict["NAME"],
"db_dump": dump_file,
}
env = {"PGPASSWORD": db_credentials_dict["PASSWORD"].replace("$", "\$")}
c.run(
"""
psql -h '{host}' -U '{user}' '{db}' '$(./manage.py sqldsn -q)' <<<'
SELECT pg_terminate_backend(pid)
FROM pg_stat_activity
WHERE pid != pg_backend_pid()'
""".format(
**db_info
),
env=env,
)
c.run("dropdb -h '{host}' -U '{user}' '{db}'".format(**db_info), env=env)
c.run("createdb -h '{host}' -U '{user}' '{db}'".format(**db_info), env=env)
c.run(
"gunzip -c {db_dump}|psql -h '{host}' -U '{user}' '{db}'".format(**db_info),
env=env,
)
@task
@remote
def deploy(c):
"""
Execute all deployment steps
"""
c.conn.create_structure()
push_code_update(c, "HEAD")
sync_settings(c)
c.conn.dump_db(c.conn.backups_root)
install_requirements(c)
dj_collect_static(c)
dj_migrate_database(c)
dj_sync_roles(c)
compile_messages(c)
restart_uwsgi(c)
c.conn.clean_old_database_backups(nb_backups_to_keep=10)
@task
@remote
def push_code_update(c, git_ref):
"""
Synchronize the remote code repository
"""
with c.conn.cd(c.conn.project_root):
# First, check that the remote deployment directory exists
try:
c.conn.run("test -d .", hide=True)
except UnexpectedExit:
raise Exit(
"Provisioning not finished, directory {} doesn't exist!".format(
c.config["root"]
)
)
# Now make sure there's git, and a git repository
try:
c.conn.git("--version", hide=True)
except UnexpectedExit:
raise Exit("Provisioning not finished, git not available!")
try:
c.conn.git("rev-parse --git-dir", hide=True)
except UnexpectedExit:
c.conn.git("init")
git_remote_url = "ssh://{user}@{host}:{port}/{directory}".format(
user=c.conn.user,
host=c.conn.host,
port=c.conn.port,
directory=c.conn.project_root,
)
# Now push our code to the remote, always as FABHEAD branch
porcelain.push(".", git_remote_url, "{}:FABHEAD".format(git_ref))
with c.conn.cd(c.conn.project_root):
c.conn.git("checkout -f -B master FABHEAD", hide=True)
c.conn.git("branch -d FABHEAD", hide=True)
# Force using an absolute URL for locale submodule since the relative one would fail
# (this uses a deploy key generated on the server)
c.conn.git(
"config submodule.locale.url git@gitlab.liip.ch:swing/defivelo/intranet-i18n.git",
hide=True,
)
c.conn.git("submodule update --init", hide=True)
vcs_commit = subprocess.run(
["git", "rev-parse", git_ref], stdout=subprocess.PIPE
).stdout.decode()
vcs_version = subprocess.run(
["git", "describe", "--tags", git_ref], stdout=subprocess.PIPE
).stdout.decode()
c.conn.set_setting("VCS_COMMIT", vcs_commit)
c.conn.set_setting("VCS_VERSION", vcs_version)
@task
@remote
def install_requirements(c):
"""
Install project requirements in venv
"""
try:
c.conn.run("test -r {}".format(c.conn.venv_path), hide=True)
except UnexpectedExit:
c.conn.mk_venv()
try:
requirements_variant = c.config.requirements
except AttributeError:
requirements_variant = "base"
c.conn.pip(f"install -r requirements/{requirements_variant}.txt")
@task
@remote
def sync_settings(c):
"""
Synchronize the settings from the above environment to the server
"""
required_settings = set(
[
"DATABASE_URL",
"MEDIA_ROOT",
"STATIC_ROOT",
"MEDIA_URL",
"STATIC_URL",
"ALLOWED_HOSTS",
]
)
env_settings = getattr(c.config, "settings", {})
for setting, value in env_settings.items():
c.conn.set_setting(setting, value=value)
# Ask for settings that are required but were not set in the parameters
# file
for setting in required_settings - set(env_settings.keys()):
c.conn.set_setting(setting, force=False)
c.conn.set_setting(
"DJANGO_SETTINGS_MODULE",
value="%s.settings.base" % project_name,
force=False,
)
c.conn.set_setting("SECRET_KEY", value=generate_secret_key(), force=False)
@task
@remote
def dj_collect_static(c):
"""
Django: collect the statics
"""
c.conn.manage_py("collectstatic --noinput")
@task
@remote
def dj_migrate_database(c):
"""
Django: Migrate the database
"""
c.conn.manage_py("migrate")
@task
@remote
def dj_sync_roles(c):
"""
Django: Synchronize Groups/Permissions with defivelo.roles
"""
c.conn.manage_py("sync_roles --reset_user_permissions")
@task
@remote
def restart_uwsgi(c):
"""
Restart uWSGI processes
"""
c.conn.run(f"uwsgi --stop '{c.conn.config.pid}'")
time.sleep(2)
c.conn.run(f"uwsgi --start '{c.conn.config.ini}'")
@task
@remote
def compile_messages(c):
c.conn.manage_py("compilemessages -l fr -l de -l en -l it")
# Environment handling stuff
############################
def create_environment_task(name, env_conf):
"""
Create a task function from an environment name
"""
@task(name=name)
def load_environment(ctx):
conf = env_conf.copy()
conf["environment"] = name
# So now conf is the ENVIRONMENTS[env] dict plus "environment" pointing to the name
# Push them in the context config dict
ctx.config.load_overrides(conf)
# Add the common_settings in there
ctx.conn = CustomConnection(host=conf["host"], inline_ssh_env=True)
ctx.conn.config.load_overrides(conf)
load_environment.__doc__ = (
"""Prepare connection and load config for %s environment""" % name
)
return load_environment
def load_environments_tasks(environments):
"""
Load environments as fabric tasks
"""
for name, env_conf in environments.items():
globals()[name] = create_environment_task(name, env_conf)
# Yes, do it
load_environments_tasks(ENVIRONMENTS)
PK ølEX·núÖ Ö SETUP.md# Comment mettre en place son environnement de développement
## Cloner le dépôt
`$ git clone -b master https://github.com/defivelo/db.git DB-DefiVelo`
## Installer les outils
- vagrant: https://liip-drifter.readthedocs.io/en/latest/requirements.html#install-requirements
## Créer un environnement virtuel et s'y connecter
```
cd DB-DefiVelo
vagrant up
vagrant ssh
```
## Créer un utilisateur super-administrateur
```
./manage.py createsuperuser
```
## Lancer le serveur Web de test
```
./manage.py runserver_plus
```
## Autre
Les autres tâches sont décrites dans le `Makefile` à la racine du projet.
Lancer `make help` dans l’environnement virtuel pour les lister,
et `make ma_tache` pour les exécuter.
PK ølEXÆÕ Õ
DockerfileFROM python:3.11-bullseye
RUN set -x; \
apt-get update -qq \
&& apt-get install -yq \
bash-completion \
postgresql-client \
gettext \
sassc \
&& rm -rf /var/lib/apt/lists/*
ARG USER_ID=1000
ARG GROUP_ID=1000
ENV PYTHONUNBUFFERED 1
ENV PYTHONPATH "${PYTHONPATH}:/code"
ENV VIRTUAL_ENV="/venv"
ENV PATH="$VIRTUAL_ENV/bin:$PATH"
RUN set -x; \
groupadd -g $GROUP_ID app && \
useradd --create-home -u $USER_ID -g app -s /bin/bash app && \
install -o app -g app -d /code "$VIRTUAL_ENV"
USER app
RUN python -m ensurepip --upgrade
RUN python -m venv "$VIRTUAL_ENV"
RUN python -m pip install --upgrade pip
WORKDIR /code
COPY entrypoint.sh /
ENTRYPOINT [ "/entrypoint.sh" ]
PK ølEXó%ÈÒa a ansible.cfg[defaults]
roles_path = virtualization/drifter/provisioning/roles
display_skipped_hosts = False
PK ølEX“Î#È[ [ .gitmodules[submodule "ext/bootstrap-datetimepicker"]
path = ext/bootstrap-datetimepicker
url = https://github.com/Eonasdan/bootstrap-datetimepicker.git
branch = master
[submodule "ext/moment"]
path = ext/moment
url = https://github.com/moment/moment.git
branch = master
[submodule "locale"]
path = locale
url = ../intranet-i18n.git
branch = master
PK ølEX}CÇåy y # docker-compose.override.example.yml# ================================
#
# Make a copy of this file and name it `docker-compose.override.yml`, then
# choose one among the following configurations and uncomment the lines.
# Finally cross your fingers and run `INITIAL=1 docker-compose up`.
# MINIMAL CONFIGURATION
# ~~~~~~~~~~~~~~~~~~~~~
#
# Visit http://localhost:8000/ to access the Django dev server and
# http://localhost:3000/ to access the Webpack dev server.
#
# version: '3.4'
# services:
# backend:
# ports:
# - 127.0.0.1:8000:8000
#
# PONTSUN CONFIGURATION
# ~~~~~~~~~~~~~~~~~~~~~
#
# Set up pontsun (https://github.com/liip/pontsun) and start it. Then visit
# https://defivelo.docker.test/ to access the Webpack dev server.
#
# version: '3.4'
# x-environment:
# &x-environment
# ALLOWED_HOSTS: >-
# defivelo.docker.test
# x-build-args: &x-build-args
# # USER_ID: 1001 # Set if your dev user is non-1000
# # GROUP_ID: 1001 # Set if your dev group is non-1000
# services:
# backend:
# environment:
# <<: *x-environment
# SSH_AUTH_SOCK: /.ssh-agent/proxy-socket
# build:
# args:
# <<: *x-build-args
# volumes:
# - pontsun_sshagent_socket_dir:/.ssh-agent
# networks:
# - default
# - pontsun
# labels:
# # With traefik 2.8~
# - 'traefik.enable=true'
# - 'traefik.http.routers.defivelo.entrypoints=http,https'
# - 'traefik.http.routers.defivelo.middlewares=https_redirect@file'
# - 'traefik.http.routers.defivelo.rule=Host(`defivelo.docker.test`)'
# - 'traefik.http.services.defivelo.loadbalancer.server.port=8000'
# networks:
# pontsun:
# external:
# name: pontsun
PK ølEXXF=ø× × docker-compose.ymlversion: '3.4'
x-environment:
&x-environment
INITIAL: "${INITIAL:-0}"
services:
db:
image: postgres:15
environment:
POSTGRES_HOST_AUTH_METHOD: trust
POSTGRES_PASSWORD:
POSTGRES_DB: defivelo
volumes:
- pgdata:/var/lib/postgresql/data
ports:
- 5432
backend:
build:
context: .
command: sh -c 'while true; do ./manage.py runserver 0.0.0.0:8000; sleep 1; done'
environment:
<<: *x-environment
ALLOWED_HOSTS: >-
localhost
DATABASE_URL: postgresql://postgres@db/defivelo
ports:
- 8000
volumes:
- venv:/venv
- .:/code
depends_on:
- db
stdin_open: true
tty: true
volumes:
pgdata:
venv:
PK ølEXIf_™á á .travis.ymllanguage: python
python:
- "3.7" # Current prod
- "3.8"
services:
- postgresql
before_script:
- psql -c 'create database test_defivelo;' -U postgres
install:
- pip install tox
script:
- tox
env:
- TOXENV=python
PK ølEXZÒH] manage.py#!/usr/bin/env python
# defivelo-intranet -- Outil métier pour la gestion du Défi Vélo
# Copyright (C) 2015 Didier Raboud
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
import os
import sys
from defivelo import get_project_root_path, import_env_vars
if __name__ == "__main__":
if 'test' in sys.argv:
env_dir = os.path.join('envdir', 'tests')
else:
env_dir = 'envdir'
import_env_vars(os.path.join(get_project_root_path(), env_dir))
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "defivelo.settings.dev")
from django.core.management import execute_from_command_line
execute_from_command_line(sys.argv)
PK ølEXLÊJ
renovate.json{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base",
"group:allNonMajor"
],
"major": {
"enabled": false
},
"pip_requirements": {
"fileMatch": [
"(^|/)[\\w-]*requirements((-|/)\\w+)?\\.(txt|pip)$"
]
}
}
PK ølEX(¡ÞXÇ Ç requirements/staging.txt#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile requirements/staging.in
#
-e git+https://github.com/liip-forks/django-agpl#egg=django-agpl
# via -r requirements/base.in
-e git+https://github.com/liip-forks/django-db-email-backend#egg=kn-django-db-email-backend
# via -r requirements/base.in
asgiref==3.7.2
# via
# django
# django-countries
beautifulsoup4==4.12.2
# via django-bootstrap3
certifi==2023.7.22
# via
# requests
# sentry-sdk
cffi==1.16.0
# via cryptography
charset-normalizer==3.3.0
# via requests
crispy-bootstrap3==2022.1
# via -r requirements/base.in
cryptography==41.0.4
# via
# -r requirements/base.in
# pyjwt
csscompressor==0.9.5
# via -r requirements/base.in
defusedxml==0.7.1
# via
# odfpy
# python3-openid
diff-match-patch==20230430
# via django-import-export
dj-database-url==2.1.0
# via -r requirements/base.in
django==4.2.6
# via
# -r requirements/base.in
# crispy-bootstrap3
# dj-database-url
# django-agpl
# django-allauth
# django-appconf
# django-autocomplete-light
# django-bootstrap3
# django-crispy-forms
# django-extensions
# django-filter
# django-ical
# django-import-export
# django-localflavor
# django-memoize
# django-parler
# django-phonenumber-field
# django-recurrence
# django-role-permissions
# django-taggit
# kn-django-db-email-backend
django-allauth==0.57.0
# via -r requirements/base.in
django-appconf==1.0.5
# via django-compressor
django-autocomplete-light==3.9.7
# via -r requirements/base.in
django-bootstrap3==23.4
# via -r requirements/base.in
django-bootstrap3-datetimepicker-2==2.8.3
# via -r requirements/base.in
django-compressor==4.4
# via -r requirements/base.in
django-countries==7.5.1
# via -r requirements/base.in
django-crispy-forms==2.0
# via
# -r requirements/base.in
# crispy-bootstrap3
django-extensions==3.2.3
# via -r requirements/staging.in
django-filter==23.3
# via -r requirements/base.in
django-ical==1.9.2
# via -r requirements/base.in
django-import-export==3.3.1
# via -r requirements/base.in
django-localflavor==4.0
# via -r requirements/base.in
django-memoize==2.3.1
# via -r requirements/base.in
django-parler==2.3
# via -r requirements/base.in
django-phonenumber-field==7.2.0
# via -r requirements/base.in
django-recurrence==1.11.1
# via django-ical
django-role-permissions==3.2.0
# via -r requirements/base.in
django-simple-history==3.4.0
# via -r requirements/base.in
django-stronghold==0.4.0
# via -r requirements/base.in
django-taggit==4.0.0
# via -r requirements/base.in
django-tinymce==3.6.1
# via -r requirements/base.in
et-xmlfile==1.1.0
# via openpyxl
icalendar==5.0.10
# via django-ical
idna==3.4
# via requests
libsass==0.22.0
# via -r requirements/base.in
markuppy==1.14
# via tablib
oauthlib==3.2.2
# via requests-oauthlib
odfpy==1.4.1
# via tablib
openpyxl==3.1.2
# via tablib
phonenumbers==8.13.22
# via -r requirements/base.in
pillow==10.0.1
# via -r requirements/base.in
psycopg2-binary==2.9.9
# via -r requirements/base.in
pycparser==2.21
# via cffi
pyjwt[crypto]==2.8.0
# via django-allauth
python-dateutil==2.8.2
# via
# django-recurrence
# icalendar
python-stdnum==1.19
# via django-localflavor
python3-openid==3.2.0
# via django-allauth
pytz==2023.3.post1
# via
# -r requirements/base.in
# icalendar
# kn-django-db-email-backend
pyyaml==6.0.1
# via
# -r requirements/base.in
# tablib
rcssmin==1.1.1
# via django-compressor
requests==2.31.0
# via
# django-allauth
# requests-oauthlib
requests-oauthlib==1.3.1
# via django-allauth
rjsmin==1.2.1
# via django-compressor
sentry-sdk==1.31.0
# via -r requirements/base.in
six==1.16.0
# via
# -r requirements/base.in
# django-autocomplete-light
# python-dateutil
soupsieve==2.5
# via beautifulsoup4
sqlparse==0.4.4
# via django
tablib[html,ods,xls,xlsx,yaml]==3.5.0
# via
# -r requirements/base.in
# django-import-export
typing-extensions==4.8.0
# via
# dj-database-url
# django-countries
urllib3==2.0.6
# via
# requests
# sentry-sdk
xlrd==2.0.1
# via tablib
xlwt==1.3.0
# via tablib
PK ølEXÁL¡x x requirements/dev.in-r test.in
pip-tools
django-debug-toolbar
django-extensions
Werkzeug
# Deployment requirements
fabric
dulwich==0.19.15
PK ølEXã.Ô2 requirements/dev.txt#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile requirements/dev.in
#
-e git+https://github.com/liip-forks/django-agpl#egg=django-agpl
# via -r requirements/base.in
-e git+https://github.com/liip-forks/django-db-email-backend#egg=kn-django-db-email-backend
# via -r requirements/base.in
asgiref==3.7.2
# via
# django
# django-countries
asttokens==2.4.0
# via stack-data
backcall==0.2.0
# via ipython
bcrypt==4.0.1
# via paramiko
beautifulsoup4==4.12.2
# via django-bootstrap3
black==23.9.1
# via
# -r requirements/test.in
# flake8-black
build==1.0.3
# via pip-tools
certifi==2023.7.22
# via
# dulwich
# requests
# sentry-sdk
cffi==1.16.0
# via
# cryptography
# pynacl
charset-normalizer==3.3.0
# via requests
click==8.1.7
# via
# black
# pip-tools
coverage[toml]==7.3.2
# via pytest-cov
crispy-bootstrap3==2022.1
# via -r requirements/base.in
cryptography==41.0.4
# via
# -r requirements/base.in
# paramiko
# pyjwt
csscompressor==0.9.5
# via -r requirements/base.in
decorator==5.1.1
# via
# fabric
# ipdb
# ipython
defusedxml==0.7.1
# via
# odfpy
# python3-openid
deprecated==1.2.14
# via fabric
diff-match-patch==20230430
# via django-import-export
dj-database-url==2.1.0
# via -r requirements/base.in
django==4.2.6
# via
# -r requirements/base.in
# crispy-bootstrap3
# dj-database-url
# django-agpl
# django-allauth
# django-appconf
# django-autocomplete-light
# django-bootstrap3
# django-crispy-forms
# django-debug-toolbar
# django-extensions
# django-filter
# django-ical
# django-import-export
# django-localflavor
# django-memoize
# django-parler
# django-phonenumber-field
# django-recurrence
# django-role-permissions
# django-taggit
# kn-django-db-email-backend
django-allauth==0.57.0
# via -r requirements/base.in
django-appconf==1.0.5
# via django-compressor
django-autocomplete-light==3.9.7
# via -r requirements/base.in
django-bootstrap3==23.4
# via -r requirements/base.in
django-bootstrap3-datetimepicker-2==2.8.3
# via -r requirements/base.in
django-compressor==4.4
# via -r requirements/base.in
django-countries==7.5.1
# via -r requirements/base.in
django-crispy-forms==2.0
# via
# -r requirements/base.in
# crispy-bootstrap3
django-debug-toolbar==4.2.0
# via -r requirements/dev.in
django-extensions==3.2.3
# via -r requirements/dev.in
django-filter==23.3
# via -r requirements/base.in
django-ical==1.9.2
# via -r requirements/base.in
django-import-export==3.3.1
# via -r requirements/base.in
django-localflavor==4.0
# via -r requirements/base.in
django-memoize==2.3.1
# via -r requirements/base.in
django-parler==2.3
# via -r requirements/base.in
django-phonenumber-field==7.2.0
# via -r requirements/base.in
django-recurrence==1.11.1
# via django-ical
django-role-permissions==3.2.0
# via -r requirements/base.in
django-simple-history==3.4.0
# via -r requirements/base.in
django-stronghold==0.4.0
# via -r requirements/base.in
django-taggit==4.0.0
# via -r requirements/base.in
django-tinymce==3.6.1
# via -r requirements/base.in
dulwich==0.19.15
# via -r requirements/dev.in
et-xmlfile==1.1.0
# via openpyxl
executing==2.0.0
# via stack-data
fabric==3.2.2
# via -r requirements/dev.in
factory-boy==3.3.0
# via -r requirements/test.in
faker==19.8.0
# via factory-boy
flake8==6.1.0
# via
# -r requirements/test.in
# flake8-black
# flake8-isort
flake8-black==0.3.6
# via -r requirements/test.in
flake8-isort==6.1.0
# via -r requirements/test.in
icalendar==5.0.10
# via django-ical
idna==3.4
# via requests
iniconfig==2.0.0
# via pytest
invoke==2.2.0
# via fabric
ipdb==0.13.13
# via -r requirements/test.in
ipython==8.16.1
# via ipdb
isort==5.12.0
# via flake8-isort
jedi==0.19.1
# via ipython
libsass==0.22.0
# via -r requirements/base.in
markuppy==1.14
# via tablib
markupsafe==2.1.3
# via werkzeug
matplotlib-inline==0.1.6
# via ipython
mccabe==0.7.0
# via flake8
mypy-extensions==1.0.0
# via black
oauthlib==3.2.2
# via requests-oauthlib
odfpy==1.4.1
# via tablib
openpyxl==3.1.2
# via tablib
packaging==23.2
# via
# black
# build
# pytest
paramiko==3.3.1
# via fabric
parso==0.8.3
# via jedi
pathspec==0.11.2
# via black
pexpect==4.8.0
# via ipython
phonenumbers==8.13.22
# via -r requirements/base.in
pickleshare==0.7.5
# via ipython
pillow==10.0.1
# via -r requirements/base.in
pip-tools==7.3.0
# via -r requirements/dev.in
platformdirs==3.11.0
# via black
pluggy==1.3.0
# via pytest
prompt-toolkit==3.0.39
# via ipython
psycopg2-binary==2.9.9
# via -r requirements/base.in
ptyprocess==0.7.0
# via pexpect
pure-eval==0.2.2
# via stack-data
pycodestyle==2.11.0
# via flake8
pycparser==2.21
# via cffi
pyflakes==3.1.0
# via flake8
pygments==2.16.1
# via ipython
pyjwt[crypto]==2.8.0
# via django-allauth
pynacl==1.5.0
# via paramiko
pyproject-hooks==1.0.0
# via build
pytest==7.4.2
# via
# -r requirements/test.in
# pytest-cov
# pytest-django
pytest-cov==4.1.0
# via -r requirements/test.in
pytest-django==4.5.2
# via -r requirements/test.in
python-dateutil==2.8.2
# via
# django-recurrence
# faker
# icalendar
python-stdnum==1.19
# via django-localflavor
python3-openid==3.2.0
# via django-allauth
pytz==2023.3.post1
# via
# -r requirements/base.in
# icalendar
# kn-django-db-email-backend
pyyaml==6.0.1
# via
# -r requirements/base.in
# tablib
rcssmin==1.1.1
# via django-compressor
requests==2.31.0
# via
# django-allauth
# requests-oauthlib
requests-oauthlib==1.3.1
# via django-allauth
rjsmin==1.2.1
# via django-compressor
sentry-sdk==1.31.0
# via -r requirements/base.in
six==1.16.0
# via
# -r requirements/base.in
# asttokens
# django-autocomplete-light
# python-dateutil
soupsieve==2.5
# via beautifulsoup4
sqlparse==0.4.4
# via
# django
# django-debug-toolbar
stack-data==0.6.3
# via ipython
tablib[html,ods,xls,xlsx,yaml]==3.5.0
# via
# -r requirements/base.in
# django-import-export
traitlets==5.11.2
# via
# ipython
# matplotlib-inline
typing-extensions==4.8.0
# via
# dj-database-url
# django-countries
urllib3==2.0.6
# via
# dulwich
# requests
# sentry-sdk
wcwidth==0.2.8
# via prompt-toolkit
werkzeug==3.0.0
# via -r requirements/dev.in
wheel==0.41.2
# via pip-tools
wrapt==1.15.0
# via deprecated
xlrd==2.0.1
# via tablib
xlwt==1.3.0
# via tablib
# The following packages are considered to be unsafe in a requirements file:
# pip
# setuptools
PK ølEX_g…ðl l requirements/base.txt#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile requirements/base.in
#
-e git+https://github.com/liip-forks/django-agpl#egg=django-agpl
# via -r requirements/base.in
-e git+https://github.com/liip-forks/django-db-email-backend#egg=kn-django-db-email-backend
# via -r requirements/base.in
asgiref==3.7.2
# via
# django
# django-countries
beautifulsoup4==4.12.2
# via django-bootstrap3
certifi==2023.7.22
# via
# requests
# sentry-sdk
cffi==1.16.0
# via cryptography
charset-normalizer==3.3.0
# via requests
crispy-bootstrap3==2022.1
# via -r requirements/base.in
cryptography==41.0.4
# via
# -r requirements/base.in
# pyjwt
csscompressor==0.9.5
# via -r requirements/base.in
defusedxml==0.7.1
# via
# odfpy
# python3-openid
diff-match-patch==20230430
# via django-import-export
dj-database-url==2.1.0
# via -r requirements/base.in
django==4.2.6
# via
# -r requirements/base.in
# crispy-bootstrap3
# dj-database-url
# django-agpl
# django-allauth
# django-appconf
# django-autocomplete-light
# django-bootstrap3
# django-crispy-forms
# django-filter
# django-ical
# django-import-export
# django-localflavor
# django-memoize
# django-parler
# django-phonenumber-field
# django-recurrence
# django-role-permissions
# django-taggit
# kn-django-db-email-backend
django-allauth==0.57.0
# via -r requirements/base.in
django-appconf==1.0.5
# via django-compressor
django-autocomplete-light==3.9.7
# via -r requirements/base.in
django-bootstrap3==23.4
# via -r requirements/base.in
django-bootstrap3-datetimepicker-2==2.8.3
# via -r requirements/base.in
django-compressor==4.4
# via -r requirements/base.in
django-countries==7.5.1
# via -r requirements/base.in
django-crispy-forms==2.0
# via
# -r requirements/base.in
# crispy-bootstrap3
django-filter==23.3
# via -r requirements/base.in
django-ical==1.9.2
# via -r requirements/base.in
django-import-export==3.3.1
# via -r requirements/base.in
django-localflavor==4.0
# via -r requirements/base.in
django-memoize==2.3.1
# via -r requirements/base.in
django-parler==2.3
# via -r requirements/base.in
django-phonenumber-field==7.2.0
# via -r requirements/base.in
django-recurrence==1.11.1
# via django-ical
django-role-permissions==3.2.0
# via -r requirements/base.in
django-simple-history==3.4.0
# via -r requirements/base.in
django-stronghold==0.4.0
# via -r requirements/base.in
django-taggit==4.0.0
# via -r requirements/base.in
django-tinymce==3.6.1
# via -r requirements/base.in
et-xmlfile==1.1.0
# via openpyxl
icalendar==5.0.10
# via django-ical
idna==3.4
# via requests
libsass==0.22.0
# via -r requirements/base.in
markuppy==1.14
# via tablib
oauthlib==3.2.2
# via requests-oauthlib
odfpy==1.4.1
# via tablib
openpyxl==3.1.2
# via tablib
phonenumbers==8.13.22
# via -r requirements/base.in
pillow==10.0.1
# via -r requirements/base.in
psycopg2-binary==2.9.9
# via -r requirements/base.in
pycparser==2.21
# via cffi
pyjwt[crypto]==2.8.0
# via django-allauth
python-dateutil==2.8.2
# via
# django-recurrence
# icalendar
python-stdnum==1.19
# via django-localflavor
python3-openid==3.2.0
# via django-allauth
pytz==2023.3.post1
# via
# -r requirements/base.in
# icalendar
# kn-django-db-email-backend
pyyaml==6.0.1
# via
# -r requirements/base.in
# tablib
rcssmin==1.1.1
# via django-compressor
requests==2.31.0
# via
# django-allauth
# requests-oauthlib
requests-oauthlib==1.3.1
# via django-allauth
rjsmin==1.2.1
# via django-compressor
sentry-sdk==1.31.0
# via -r requirements/base.in
six==1.16.0
# via
# -r requirements/base.in
# django-autocomplete-light
# python-dateutil
soupsieve==2.5
# via beautifulsoup4
sqlparse==0.4.4
# via django
tablib[html,ods,xls,xlsx,yaml]==3.5.0
# via
# -r requirements/base.in
# django-import-export
typing-extensions==4.8.0
# via
# dj-database-url
# django-countries
urllib3==2.0.6
# via
# requests
# sentry-sdk
xlrd==2.0.1
# via tablib
xlwt==1.3.0
# via tablib
PK ølEX´ÖŒc c requirements/test.in-r base.in
pytest
pytest-django
pytest-cov
black
flake8
flake8-black
flake8-isort
factory_boy
ipdb
PK ølEX~o¹: : requirements/base.indj-database-url
Django~=4.2.0
pytz
django-bootstrap3
psycopg2-binary
django-compressor
libsass
csscompressor
django-stronghold
django-allauth
crispy-bootstrap3
django-crispy-forms
django-localflavor
django-phonenumber-field
phonenumbers
django-bootstrap3-datetimepicker-2
django-autocomplete-light
django-autocomplete-light
django-parler
django-filter
django-import-export
# Need to drop that unmaintained dependency
-e git+https://github.com/liip-forks/django-agpl#egg=django-agpl
tablib
django-taggit
pillow
django-role-permissions
django-tinymce
django-memoize
django-countries
django-simple-history
sentry-sdk
six
# TODO: Get rid of this unmaintained dependency by using mailhog (DEFIVELO-260)
-e git+https://github.com/liip-forks/django-db-email-backend#egg=kn-django-db-email-backend
django-ical
cryptography
pyyaml
PK ølEXšðL L requirements/test.txt#
# This file is autogenerated by pip-compile with Python 3.11
# by the following command:
#
# pip-compile requirements/test.in
#
-e git+https://github.com/liip-forks/django-agpl#egg=django-agpl
# via -r requirements/base.in
-e git+https://github.com/liip-forks/django-db-email-backend#egg=kn-django-db-email-backend
# via -r requirements/base.in
asgiref==3.7.2
# via
# django
# django-countries
asttokens==2.4.0
# via stack-data
backcall==0.2.0
# via ipython
beautifulsoup4==4.12.2
# via django-bootstrap3
black==23.9.1
# via
# -r requirements/test.in
# flake8-black
certifi==2023.7.22
# via
# requests
# sentry-sdk
cffi==1.16.0
# via cryptography
charset-normalizer==3.3.0
# via requests
click==8.1.7
# via black
coverage[toml]==7.3.2
# via pytest-cov
crispy-bootstrap3==2022.1
# via -r requirements/base.in
cryptography==41.0.4
# via
# -r requirements/base.in
# pyjwt
csscompressor==0.9.5
# via -r requirements/base.in
decorator==5.1.1
# via
# ipdb
# ipython
defusedxml==0.7.1
# via
# odfpy
# python3-openid
diff-match-patch==20230430
# via django-import-export
dj-database-url==2.1.0
# via -r requirements/base.in
django==4.2.6
# via
# -r requirements/base.in
# crispy-bootstrap3
# dj-database-url
# django-agpl
# django-allauth
# django-appconf
# django-autocomplete-light
# django-bootstrap3
# django-crispy-forms
# django-filter
# django-ical
# django-import-export
# django-localflavor
# django-memoize
# django-parler
# django-phonenumber-field
# django-recurrence
# django-role-permissions
# django-taggit
# kn-django-db-email-backend
django-allauth==0.57.0
# via -r requirements/base.in
django-appconf==1.0.5
# via django-compressor
django-autocomplete-light==3.9.7
# via -r requirements/base.in
django-bootstrap3==23.4
# via -r requirements/base.in
django-bootstrap3-datetimepicker-2==2.8.3
# via -r requirements/base.in
django-compressor==4.4
# via -r requirements/base.in
django-countries==7.5.1
# via -r requirements/base.in
django-crispy-forms==2.0
# via
# -r requirements/base.in
# crispy-bootstrap3
django-filter==23.3
# via -r requirements/base.in
django-ical==1.9.2
# via -r requirements/base.in
django-import-export==3.3.1
# via -r requirements/base.in
django-localflavor==4.0
# via -r requirements/base.in
django-memoize==2.3.1
# via -r requirements/base.in
django-parler==2.3
# via -r requirements/base.in
django-phonenumber-field==7.2.0
# via -r requirements/base.in
django-recurrence==1.11.1
# via django-ical
django-role-permissions==3.2.0
# via -r requirements/base.in
django-simple-history==3.4.0
# via -r requirements/base.in
django-stronghold==0.4.0
# via -r requirements/base.in
django-taggit==4.0.0
# via -r requirements/base.in
django-tinymce==3.6.1
# via -r requirements/base.in
et-xmlfile==1.1.0
# via openpyxl
executing==2.0.0
# via stack-data
factory-boy==3.3.0
# via -r requirements/test.in
faker==19.8.0
# via factory-boy
flake8==6.1.0
# via
# -r requirements/test.in
# flake8-black
# flake8-isort
flake8-black==0.3.6
# via -r requirements/test.in
flake8-isort==6.1.0
# via -r requirements/test.in
icalendar==5.0.10
# via django-ical
idna==3.4
# via requests
iniconfig==2.0.0
# via pytest
ipdb==0.13.13
# via -r requirements/test.in
ipython==8.16.1
# via ipdb
isort==5.12.0
# via flake8-isort
jedi==0.19.1
# via ipython
libsass==0.22.0
# via -r requirements/base.in
markuppy==1.14
# via tablib
matplotlib-inline==0.1.6
# via ipython
mccabe==0.7.0
# via flake8
mypy-extensions==1.0.0
# via black
oauthlib==3.2.2
# via requests-oauthlib
odfpy==1.4.1
# via tablib
openpyxl==3.1.2
# via tablib
packaging==23.2
# via
# black
# pytest
parso==0.8.3
# via jedi
pathspec==0.11.2
# via black
pexpect==4.8.0
# via ipython
phonenumbers==8.13.22
# via -r requirements/base.in
pickleshare==0.7.5
# via ipython
pillow==10.0.1
# via -r requirements/base.in
platformdirs==3.11.0
# via black
pluggy==1.3.0
# via pytest
prompt-toolkit==3.0.39
# via ipython
psycopg2-binary==2.9.9
# via -r requirements/base.in
ptyprocess==0.7.0
# via pexpect
pure-eval==0.2.2
# via stack-data
pycodestyle==2.11.0
# via flake8
pycparser==2.21
# via cffi
pyflakes==3.1.0
# via flake8
pygments==2.16.1
# via ipython
pyjwt[crypto]==2.8.0
# via django-allauth
pytest==7.4.2
# via
# -r requirements/test.in
# pytest-cov
# pytest-django
pytest-cov==4.1.0
# via -r requirements/test.in
pytest-django==4.5.2
# via -r requirements/test.in
python-dateutil==2.8.2
# via
# django-recurrence
# faker
# icalendar
python-stdnum==1.19
# via django-localflavor
python3-openid==3.2.0
# via django-allauth
pytz==2023.3.post1
# via
# -r requirements/base.in
# icalendar
# kn-django-db-email-backend
pyyaml==6.0.1
# via
# -r requirements/base.in
# tablib
rcssmin==1.1.1
# via django-compressor
requests==2.31.0
# via
# django-allauth
# requests-oauthlib
requests-oauthlib==1.3.1
# via django-allauth
rjsmin==1.2.1
# via django-compressor
sentry-sdk==1.31.0
# via -r requirements/base.in
six==1.16.0
# via
# -r requirements/base.in
# asttokens
# django-autocomplete-light
# python-dateutil
soupsieve==2.5
# via beautifulsoup4
sqlparse==0.4.4
# via django
stack-data==0.6.3
# via ipython
tablib[html,ods,xls,xlsx,yaml]==3.5.0
# via
# -r requirements/base.in
# django-import-export
traitlets==5.11.2
# via
# ipython
# matplotlib-inline
typing-extensions==4.8.0
# via
# dj-database-url
# django-countries
urllib3==2.0.6
# via
# requests
# sentry-sdk
wcwidth==0.2.8
# via prompt-toolkit
xlrd==2.0.1
# via tablib
xlwt==1.3.0
# via tablib
PK ølEXO½'ß requirements/staging.in-r base.in
django-extensions
PK Æ…eXLžç' defivelo/wsgi.py# defivelo-intranet -- Outil métier pour la gestion du Défi Vélo
# Copyright (C) 2015 Didier Raboud
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
"""
WSGI config for defivelo project.
It exposes the WSGI callable as a module-level variable named ``application``.
For more information on this file, see
https://docs.djangoproject.com/en/1.8/howto/deployment/wsgi/
"""
import os
from django.core.wsgi import get_wsgi_application
from defivelo import get_project_root_path, import_env_vars
import_env_vars(os.path.join(get_project_root_path(), "envdir"))
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "defivelo.settings.base")
application = get_wsgi_application()
PK ølEXÔ±ñ ñ defivelo/__init__.py# defivelo-intranet -- Outil métier pour la gestion du Défi Vélo
# Copyright (C) 2015 Didier Raboud
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
import glob
import os
def import_env_vars(directory):
"""
List the files present in the given directory and for each of them create
an environment variable named after the file, and which value is the
contents of the file.
"""
env_vars = glob.glob(os.path.join(directory, "*"))
for env_var in env_vars:
if os.path.isfile(env_var):
with open(env_var, "r") as env_var_file:
os.environ.setdefault(
env_var.split(os.sep)[-1], env_var_file.read().strip()
)
def get_project_root_path():
"""
Return the absolute path to the root of the project.
"""
return os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir))
PK ølEXŽi²¾G G defivelo/roles.py# defivelo-intranet -- Outil métier pour la gestion du Défi Vélo
# Copyright (C) 2016 Didier Raboud
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
from django.utils.translation import gettext_lazy as _
from memoize import memoize
from rolepermissions.checkers import has_permission as uncached_has_permission
from rolepermissions.roles import AbstractUserRole
from apps.common import DV_STATES
# Override 'has_permission' from rolepermissions to add memoization for performance reasons
@memoize()
def has_permission(user, permission_name):
return uncached_has_permission(user, permission_name)
@memoize()
def user_cantons(user):
"""
List of the cantons _managed_ by this user
"""
if has_permission(user, "cantons_all"):
return DV_STATES
elif has_permission(user, "cantons_mine"):
return [m.canton for m in user.managedstates.all()]
else:
raise LookupError("No user cantons")
class Collaborator(AbstractUserRole):
"""
Moniteur 1, 2 ou Intervenant
"""
available_permissions = {
"challenge_see_all_orga": True,
"user_view_list": True,
"user_view_list_non_collaborator": False,
"user_export_all_fields": False,
"timesheet": True,
}
class StateManager(AbstractUserRole):
"""
Chargé de projet, responsable d’un ou plusieurs cantons
"""
available_permissions = {
"cantons_all": False,
"cantons_mine": True,
"user_view_list": True,
"user_view_list_non_collaborator": True,
"user_export_all_fields": True,
"user_detail_other": True,
"user_edit_other": True,
"user_crud_dv_public_fields": True,
"user_crud_dv_private_fields": True,
"user_can_send_credentials": True,
"user_create": True,
"orga_detail_all": True,
"orga_crud": True,
"orga_edit_address": True,
"orga_show": True,
"orga_edit": True,
"challenge_season_crud": True,
"challenge_see_all_orga": True,
"challenge_session_crud": True,
"challenge_invoice_cru": True,
"challenge_invoice_reset_to_draft": False,
"challenge_season_see_state_planning": True,
"settings_crud": True,
"timesheet": True,
"timesheet_editor": True,
"registration_validate": True,
"assign_only_coordinator_role": True,
}
class PowerUser(AbstractUserRole):
"""
Bureau
"""
available_permissions = {
"cantons_all": True,
"cantons_mine": True,
"user_view_list": True,
"user_view_list_non_collaborator": True,
"user_export_all_fields": True,
"user_detail_other": True,
"user_edit_other": True,
"user_create": True,
"user_crud_dv_public_fields": True,
"user_crud_dv_private_fields": True,
"user_edit_employee_code": True,
"user_can_send_credentials": True,
"user_can_resend_credentials": True,
"user_deletions": True,
"user_set_role": True,
"user_mark_inactive": True,
"home_article_cud": True,
"orga_detail_all": True,
"orga_crud": True,
"orga_edit_address": True,
"orga_show": True,
"orga_edit": True,
"challenge_invoice_cru": True,
"challenge_invoice_reset_to_draft": True,
"challenge_see_all_orga": True,
"challenge_session_crud": True,
"challenge_season_crud": True,
"challenge_season_see_state_planning": True,
"settings_crud": True,
"timesheet": True,
"timesheet_control": True,
"timesheet_editor": True,
"export_yearly_invoices": True,
}
class Coordinator(AbstractUserRole):
"""
Coordinateur d’établissement
"""
available_permissions = {
"coordinator_home": True,
"orga_show": True,
"orga_edit": True,
"challenge_see_all_orga": False,
"registration_create": True,
}
DV_AVAILABLE_ROLES = (
(None, _("Aucun rôle")),
("collaborator", _("Collabora·teur·trice")),
("state_manager", _("Chargé·e de projet")),
("coordinator", _("Coordina·teur·trice")),
("power_user", _("Bureau de coordination")),
)
DV_AUTOMATIC_ROLES = ["collaborator"]
PK ølEXvÝVû· · defivelo/bootstrap3.pyfrom django.forms.widgets import ChoiceWidget
from bootstrap3.renderers import FieldRenderer, InlineFieldRenderer
from bootstrap3.utils import add_css_class
class DvFieldRendererMixin:
def get_form_group_class(self):
"""
Override to avoid applying `required_css_class` on Selects with no empty choice
"""
form_group_class = self.form_group_class
if self.field.errors:
if self.error_css_class:
form_group_class = add_css_class(form_group_class, self.error_css_class)
else:
if self.field.form.is_bound:
form_group_class = add_css_class(
form_group_class, self.success_css_class
)
widget = self.field.field.widget
if (
self.field.field.required
and self.required_css_class
and not (
# `widget` is a non-multiple select with no empty value
widget
and isinstance(widget, ChoiceWidget)
and not widget.allow_multiple_selected
and all(
val not in self.field.field.empty_values
for val, _ in self.field.field.choices
)
)
):
form_group_class = add_css_class(form_group_class, self.required_css_class)
if self.layout == "horizontal":
form_group_class = add_css_class(
form_group_class, self.get_size_class(prefix="form-group")
)
return form_group_class
class DvFieldRenderer(DvFieldRendererMixin, FieldRenderer):
pass
class DvInlineFieldRenderer(DvFieldRendererMixin, InlineFieldRenderer):
pass
PK ølEX¨ùÀ À defivelo/accounts.py# defivelo-intranet -- Outil métier pour la gestion du Défi Vélo
# Copyright (C) 2015 Didier Raboud
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
from allauth.account.adapter import DefaultAccountAdapter
class NoSignupAccountAdapter(DefaultAccountAdapter):
def is_open_for_signup(self, request):
return False
PK ølEX2<ã¼Y Y defivelo/context_processors.pyfrom django.utils import timezone
def now(request):
return {"now": timezone.now()}
PK ølEXÇ~„öþ þ defivelo/urls.py# defivelo-intranet -- Outil métier pour la gestion du Défi Vélo
# Copyright (C) 2015 Didier Raboud
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see .
from django.conf import settings
from django.conf.urls import include
from django.conf.urls.i18n import i18n_patterns
from django.contrib import admin
from django.urls import re_path
from django.utils.translation import gettext_lazy as _
from .views.common import HomeView, LicenseView
admin.autodiscover()
urlpatterns = [
re_path(r"^admin/", admin.site.urls),
re_path(r"^i18n/", include("django.conf.urls.i18n")),
re_path(r"^accounts/", include("allauth.urls")),
re_path(r"^license/", LicenseView.as_view(), name="license"),
re_path(r"^agpl-", include("django_agpl.urls")),
re_path(r"^article/", include("apps.article.urls")),
re_path(r"^tinymce/", include("tinymce.urls")),
]
urlpatterns += i18n_patterns(
re_path(r"^$", HomeView.as_view(), name="home"),
re_path(r"^season/", include("apps.challenge.urls")),
re_path(r"^orga/", include("apps.orga.urls")),
re_path(r"^user/", include("apps.user.urls")),
re_path(r"^info/", include("apps.info.urls")),
re_path(r"^finance/", include("apps.salary.urls")),
)
if settings.DEBUG:
import debug_toolbar
urlpatterns = [
re_path(r"^__debug__/", include(debug_toolbar.urls)),
] + urlpatterns
admin.site.site_header = _("Intranet DÉFI VÉLO")
PK ølEX<¤Äw~ ~ defivelo/static/favicon.ico h ( שSשSoשSËשSôשSôשSËשSoשS שSשSÏשSÿשSÿשSÿשSÿשSÿשSÿשSÐשS שSשSÐשSÿשSÚשSRשS
שS
שSRשSÙשSÿשSÑשS שSnשSÿשSØשS שSשSØשSÿשSn שSÇשSÿשSR IFÌ>IF̱IFÌ
שSRשSÿשSÇ ×©SùשSÿשS IF̱IFÌÿIFÌ»IFÌ
שSשSÿשSó שSùשSÿשS IFÌ
IFÌ»IFÌÿIF̲ שS
שSÿשSø שSÇשSÿשSR IFÌ
IF̱IFÌ> שSRשSÿשSÇ ×©SmשSÿשSÙשS שSשSØשSÿשSm שSשSÏשSÿשSÚשSRשSשSשSRשSÚשSÿשSÐשS שSשSÏשSÿשSÿשSÿשSÿשSÿשSÿשSÏשS שSשSnשSÇשSóשSóשSÇשSnשS ÿÿ ÿÿ ü? ð ãÇ çç Îó Ìs Î3 Ïs çç ãÇ ð ü? ÿÿ ÿÿ PK ølEXÔl:uÑ Ñ &