Suivi des déploiements
Go to file
Frédéric Péters 39fa8e2970
gitea/scrutiny/pipeline/head This commit looks good Details
fix variable name used for version number (#87687)
2024-03-02 16:54:56 +01:00
debian debian: add back memory-report to uwsgi default configuration (#80451) 2023-11-13 11:35:17 +01:00
scrutiny fix variable name used for version number (#87687) 2024-03-02 16:54:56 +01:00
.git-blame-ignore-revs misc: update git-blame-ignore-revs to ignore quote changes (#79788) 2023-08-16 11:53:30 +02:00
.gitignore misc: ignore style.css generated file 2023-06-02 11:20:33 +02:00
.pre-commit-config.yaml misc: add pre commit hook to force single quotes (#79788) 2023-08-16 11:53:30 +02:00
COPYING add COPYING and README file 2015-11-18 15:11:04 +01:00
Jenkinsfile ci: build deb package for bookworm (#78968) 2023-06-23 16:48:48 +02:00
MANIFEST.in misc: switch to scss (#77952) 2023-05-26 21:57:52 +02:00
README misc: update & run pre-commit for django-upgrade (#77825) 2023-05-25 12:01:06 +02:00
manage.py misc: apply double-quote-string-fixer (#79788) 2023-08-16 11:53:30 +02:00
pylint.rc pylint: remove obsolete options 2023-05-13 09:27:04 +02:00
pylint.sh ci: update jenkins to check codestyle 2022-04-29 08:20:57 +02:00
requirements.txt misc: add python 3 compat 2016-07-30 18:03:56 +02:00
setup.py misc: apply double-quote-string-fixer (#79788) 2023-08-16 11:53:30 +02:00
tox.ini ci: keep on using pylint 2 while pylint-django is not ready (#81905) 2023-10-03 08:16:26 +02: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 py39 --skip-string-normalization --line-length 110

isort is used to format the imports, using those parameters:

    isort --profile black --line-length 110

pyupgrade is used to automatically upgrade syntax, using those parameters:

    pyupgrade --keep-percent-format --py39-plus

django-upgrade is used to automatically upgrade Django syntax, using those parameters:

    django-upgrade --target-version 3.2

djhtml is used to automatically indent html files, using those parameters:

    djhtml --tabwidth 2

There is .pre-commit-config.yaml to use pre-commit to automatically run black,
isort, pyupgrade, django-upgrade and djhtml 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/>.