Suivi des déploiements
Go to file
Frédéric Péters bf632fe465 models: add on_delete to forein key fields 2021-05-04 22:20:54 +02:00
debian paint it with a newer black 2020-12-16 15:48:05 +01:00
scrutiny models: add on_delete to forein key fields 2021-05-04 22:20:54 +02:00
.git-blame-ignore-revs misc: add black files/notes 2021-01-17 10:37:15 +01:00
.gitignore .gitignore 2013-08-07 18:46:42 +02:00
.pre-commit-config.yaml misc: add black files/notes 2021-01-17 10:37:15 +01:00
COPYING add COPYING and README file 2015-11-18 15:11:04 +01:00
Jenkinsfile jenkins: update to build packagefor origin/main branch 2021-04-30 11:12:18 +02:00
MANIFEST.in add MANIFEST.in 2015-11-18 15:23:10 +01:00
README misc: add black files/notes 2021-01-17 10:37:15 +01:00
manage.py update script shebang to point to python3 2020-01-27 18:10:38 +01:00
requirements.txt misc: add python 3 compat 2016-07-30 18:03:56 +02:00
setup.py paint it with a newer black 2020-12-16 15:48:05 +01:00

README

Scrutiny
========

Scrutiny is a tracker of installed modules.


Installation
------------

Dependencies can be installed with pip,

 $ pip install -r requirements.txt

It's then required to get the database configured (./manage.py migrate); by
default it will create a db.sqlite3 file.

You can then run the Django test server for a quick try (you should refer to
the Django documentation for production deployments).

 $ ./manage.py runserver


Settings
--------

Default settings are loaded from settings.py, they can be overloaded by a
local_settings.py file set in the same directory, or by a file referenced
in the SCRUTINY_SETTINGS_FILE environment variable.


Code Style
----------

black is used to format the code, using thoses parameters:

    black --target-version py37 --skip-string-normalization --line-length 110

There is .pre-commit-config.yaml to use pre-commit to automatically run black
before commits. (execute `pre-commit install` to install the git hook.)


License
-------

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 <http://www.gnu.org/licenses/>.