Skip to content

How does it work?

Corentin Bettiol edited this page Nov 6, 2019 · 9 revisions

The checks system used in this django module is not something you usually see in Python projects.

image

I'm lost! Why are there so many files?

The main reason to the unusual organization of this module is to provide a simple & clean interface to create your own checks.


What is the meaning of all those files ?

Each file is a check (or a group of checks on the same parameter), except launch_checks.py & __init__.py.

What is the file launch_checks.py for ?

Since a03d6599, its purpose is to execute functions on submodules located in django-check-seo.checks.*.

That means you only need to drop your file in the checks/ folder, and the script will import it and execute it automatically (so it's an example of automatic information processing).

What is the file __init__.py for ?

It lists the files inside the checks/ folder, then add the modules to the __all__ var (it's the var that makes modules available in the from . import * in launch_checks.py)


Content

If you want to know the reasons why we chose these checks in particular.

Checks that are not included inside the project


Code

Clone this wiki locally