common-framework


Namecommon-framework JSON
Version 2024.3.1 PyPI version JSON
download
home_pageNone
SummaryAll-in-one framework for Django and Django REST Framework
upload_time2024-03-19 21:32:08
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseNone
keywords
VCS
bugtrack_url
requirements Django Pillow PyYAML celery djangorestframework flake8 model-bakery python-dateutil pip psycopg requests setuptools uritemplate wheel
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Framework commun

Boîte à outils commune pour des développements autour de Django (https://www.djangoproject.com/) et 
Django REST Framework (http://www.django-rest-framework.org/).

## Django

### Entités

Une entité est un super-modèle Django offrant un nombre important de nouvelles fonctionnalités tels que l'historisation
des données, la réversion, les métadonnées, la sérialisation et la représentation des données sous forme de
dictionnaire.

Pour utiliser ces fonctionnalités, il est nécessaire de faire hériter chaque modèle de ``common.models.Entity`` qui
hérite lui-même de ``django.db.models.Model``.

```python
from common.models import Entity

class Personne(Entity):
    pass
```

Les modèles entités possèdent par défaut les champs suivants :
* ``creation_date`` : date de création de l'entité
* ``modification_date`` : date de dernière modification de l'entité
* ``current_user`` : dernier utilisateur à l'origine de la création/modification
* ``uuid`` : identifiant unique de l'entité

L'identifiant unique permet de retrouver n'importe quelle entité depuis la base de données car chacune est
enregistrée dans un référentiel global conjointement à son type. Il est donc possible de récupérer une entité ainsi :

```python
from common.models import Global

entity = Global.objects.from_uuid('4b9abebd-8157-4e49-bcae-1a7e063a9f86')
```

> Attention ! Les entités surchargent les méthodes de persistance par défaut de Django 
(``save()``, ``create()``, ``delete()``).
``update()`` garde cependant son comportement par défaut car il exécute directement la mise à jour en base de 
données, il sera donc impossible de détecter les changements si elle est utilisée.

Une version allégée d'entité est à disposition sans l'historisation ni le référentiel global, il suffit alors
d'hériter les modèles de ``common.models.CommonModel`` à la place de ``common.models.Entity``.

### Entités périssables

Une entité périssable possède une durée de validité dans le temps, elle possède les mêmes fonctionnalités que l'entité
mais possède en prime une date de début (``start_date``) et une date de fin potentielle (``end_date``).

Pour définir une entité périssable, il suffit de faire hériter le modèle de ``common.models.PerishableEntity`` au lieu
de ``common.models.Entity``. Il n'existe pas d'alternative simplifiée hors historisation des entités périssables.

Lorsqu'une entité périssable existante en base de données est sauvegardée, le mécanisme suivant s'exécute :
* si une date de fin est fournie, l'entité courante est modifiée et clôturée à cette date
* sans date de fin fournie, l'entité courante est clôturée à cette date et une autre entité avec les modifications est 
créée avec une date de début actualisée et sans date de fin programmée

Les entités périssables implémentent une fonction de récupération des données par rapport à une date donnée, si la date
n'est pas fournie la requête récupérera toutes les entités qui sont valides par rapport à la date et heure courante.

```python
adresses = Adresse.objects.filter(personne_id=1).select_valid(date='2016-08-01T00:00:00')
```

### Administration

Afin de garantir les fonctionnalités de l'historisation dans l'interface  d'administration, il est nécessaire de faire
hériter les classes d'administration de ``common.admin.EntityAdmin`` qui permet les fonctionnalités suivantes :

* Gère automatiquement l'utilisateur connecté pour les modifications
* Affiche automatiquement la date de création et de modification et fournit les filtres de recherche
* Gère les permissions d'affichage
* Affiche les métadonnées de l'entité

Pour les entités périssables, il convient d'utiliser ``common.admin.PerishableEntityAdmin`` à la place de
``common.admin.EntityAdmin``.

Pour les inlines, des équivalents pour les entités sont également à disposition : 
``common.admin.EntityTabularInline`` et ``common.admin.EntityStackedInline``.

Une version allégée existe pour ``common.models.CommonModel`` qui est ``common.admin.CommonAdmin`` qui implémente
l'ensemble des fonctionnalités en dehors de l'historisation.

### Historisation

Toute altération au niveau des données d'un modèle entité est détectée et enregistrée dans un historique,
cela permet un suivi des modifications par utilisation ainsi que la possibilité de revenir à un état antérieur pour
l'entité ou un champ spécifique de l'entité.

A chaque modification, un historique d'entité (``common.models.History``) est sauvegardé pour l'entité et un élément 
par champ modifié dans l'historique (``common.models.HistoryField``) uniquement s'il s'agit d'une modification.

* Les relations de type many-to-many sont traités séparément à l'historisation.
* Si Celery est installé (http://www.celeryproject.org/), l'historisation est exécutée de manière asynchrone.
* L'utilisateur à l'origine de la modification est conservé dans l'historique.
* Il est possible d'ajouter un message et/ou modifier l'utilisateur à l'historique via le code.

```python
personne = Personne(nom='Marc', age=30)
personne.save(_current_user=utilisateur, _reason="Message d'information")
```

Il est possible sur un historique d'entité ou un historique de champ de demander une restauration des données de
l'historique ciblé sur l'entité concernée grâce à la méthode ```restore()```, il est possible de lui passer
également un utilisateur et un message d'information.

La restauration provoque elle-même un historique spécifique qui permet de revenir en arrière si nécessaire.

```python
history.restore(current_user=utilisateur, reason="Message d'information", rollback=False)
# rollback permet de regénérer complètement l'entité si elle a été supprimée
```

### Métadonnées

Les métadonnées permettent d'ajouter des données tierces sur une entité, ces données peuvent être structurées comme
l'utilisateur le souhaitera et seront stockées sous forme de JSON dans la base de données. Chaque entité possède des
méthodes permettant d'accéder aux métadonnées de l'entité.

Les données stockées dans les métadonnées peuvent être de n'importe quel type Python à condition que ce dernier ainsi
que les données qu'il contient éventuellement soient sérialisables (list, dict, int, float, etc...).

```python
personne.set_metadata('cle', 'valeur')
personne.get_metadata('cle')
>>> 'valeur'
personne.del_metadata('cle')
personne.get_metadata('cle')
>>> None
```

Les métadonnées d'une entité peuvent être directement utilisées dans des requêtes même si ce n'est pas recommandé pour
des raisons de performances (en fonction du volume de données).
Elles sont représentées sous forme d'un modèle Django ``common.models.MetaData``.

```python
Personne.objects.filter(metadata__key='cle', metadata__value='valeur').first()
MetaData.objects.search(key='cle', value='valeur', type=Personne)
```

### Sérialisation

Chaque entité ou requête concernant une entité peut être sérialisée en utilisant la méthode 
``serialize(format='json')`` dans l'un des formats suivants:
* JSON
* XML
* YAML

```python
personne = Personne.objects.first()
resultat = personne.serialize()
resultat
>>> [json] Personne (1)
resultat.data
>>> '[{"nom": "Marc", "age": 30}]'
personne = resultat.deserialize()
personne
>>> Personne: Marc (30 ans)
```

```python
personnes = Personne.objects.all()
resultat = personnes.serialize()
resultat
>>> [json] Personne (2)
resultat.data
>>> '[{"nom": "Marc", "age": 30}, {"nom": "Eric", "age": 40}]'
personnes = resultat.deserialize()
personnes
>>> [Personne: Marc (30 ans), Personne: Eric (40 ans)]
```

### Représentation en dictionnaire

Une requête ou une entité peut être représentée par un dictionnaire Python avec la méthode ``to_dict()``.

```python
personne.to_dict()
>>> {"nom": "Marc", "age": 30}
Personne.objects.all().to_dict()
>>> [{"nom": "Marc", "age": 30}, {"nom": "Eric", "age": 40}]
```

``to_dict()`` prend plusieurs arguments optionnels en paramètres, la méthode est documentée dans le code.

### Type d'entité

Django conserve systématiquement le type des différents modèles en base de données, les entités possèdent un moyen
simple pour récupérer ce type sur chaque entité de manière performante et unique.

```python
Personne.get_model_type()
>>> <ContentType: Personne>
personne.model_type
>>> <ContentType: Personne>
```

### WebHooks

Un webhook est un callback HTTP qui transmet des données à un serveur externe en fonction d'une action 
réalisée sur l'application. Le récepteur doit être en mesure de comprendre le message qui est transmis.
Il est possible de configurer un webhook qui réagit à un ou plusieurs actions sur une ou plusieurs entités.

Les actions couvertes sont les suivantes :
* Création
* Modification
* Suppression
* Relations de type many-to-many

Un webhook peut être configuré pour utiliser une authentification sur le serveur externe si nécessaire.

Par défaut, le webhook exécute la méthode ``to_dict()`` sur l'instance concerné avec les paramètres définis dans
``NOTIFY_OPTIONS``, mais il est possible de changer ce comportement en définissant une méthode ``get_webhook_data`` au
niveau du modèle.

Les notifications des changements par webhook est désactivée par défaut et peut être activé via ``NOTIFY_CHANGES``.

### Usage de service

L'usage des services permet de compter le nombre de fois où une URL est appelée dans l'application par un même
utilisateur et même de limiter le nombre d'usages.

La fonctionnalité est désactivée par défaut et peut être activée via ``SERVICE_USAGE``. 
Il est également nécessaire d'ajouter ``'common.middleware.ServiceUsageMiddleware'`` dans ``MIDDLEWARE_CLASSES``.

Configuration :

* ``SERVICE_USAGE`` (``False`` par défaut) : active ou non la surveillance
* ``SERVICE_USAGE_LOG_DATA`` (``False`` par défaut) : suit également les données transmisses par les services
* ``SERVICE_USAGE_LIMIT_ONLY`` (``False`` par défaut) : utilise uniquement le système de restriction des services

### Métadonnées utilisateurs & groupes

De la même manière que sur les entités, les utilisateurs et les groupes ont la possibilité de conserver de 
l'information contextuelle sous forme de métadonnée, cependant le fonctionnement diffère car ces modèles peuvent être
substitués dans le développement.

Il s'agit alors d'une relation de type one-to-one systématiquement présent à la création d'un nouvel utilisateur ou
d'un nouveau groupe et possédant un champ de type JSON pour contenir ces données.

## Utilitaires

Un grand nombre de fonctions, décorateurs et classes utilitaires sont à disposition des développeurs pour accélérer la
production de nouvelles fonctionnalités. Ces utilitaires sont regroupés dans ``common.utils`` pour tout ce qui est
relatif à Django et dans ``common.api.utils`` pour tout ce qui est relatif à Django REST Framework.

* ``singleton`` : décorateur permettant de transformer une classe en singleton
* ``get_current_app`` : permet de récupérer l'application Celery actuelle ou un mock si Celery n'est pas installé
* ``parsedate`` : permet d'évaluer une date dans n'importe quel format
* ``timeit`` : décorateur permettant de calculer le temps d'exécution d'une fonction
* ``synchronized`` : décorateur permettant de rendre thread-safe l'exécution d'une fonction
* ``temporary_upload`` : décorateur permettant à une vue de supporter l'import d'un fichier de manière temporaire
* ``download_file`` : décorateur permettant à une vue de supporter le téléchargement d'un fichier
* ``render_to`` : décorateur permettant de simplifier l'écriture d'une vue avec template
* ``ajax_request`` : décorateur permettant à une vue de se comporter comme une api_view
* ``evaluate`` : permet d'évaluer une expression Python de manière plus sûre
* ``execute`` : permet d'exécuter du code Python de manière plus sûre
* ``patch_settings`` : context manager permettant d'altérer la configuration le temps de l'exécution
* ``recursive_dict_product`` : permet de faire un produit cartésien des données d'un dictionnaire
* ``get_choices_fields`` : permet de récupérer les choix des modèles d'une ou plusieurs applications
* ``get_prefetchs`` : permet de récupérer toutes les relations inversées d'un modèle
* ``get_related`` : permet de récupérer toutes les relations ascendantes d'un modèle
* ``prefetch_generics`` : permet de récupérer les relations génériques d'un modèle
* ``str_to_bool`` : permet de convertir une chaîne de caractères quelconque en booléen
* ``decimal`` : permet de convertir un élément quelconque en nombre décimal
* ``decimal_to_str`` : permet de convertir un nombre décimal en chaîne de caractères
* ``recursive_get_urls`` : permet de récupérer toutes les URLs d'un module
* ``idict`` : dictionnaire donc les clés sont toujours converties dans un format uniforme
* ``sort_dict`` : permet de trier un dictionnaire par ses clés
* ``merge_dict`` : permet de fusionner un ou plusieurs dictionnaires imbriqués sur un autre
* ``null`` : objet nul absolu retournant toujours une valeur nulle sans erreur
* ``to_tuple`` : permet de convertir un dictionnaire en un tuple
* ``to_object`` : permet de convertir un dictionnaire en un objet Python
* ``get_size`` : permet de récupérer la taille en mémoire d'un objet Python quelconque
* ``file_is_text`` : permet de vérifier qu'un fichier est au format texte
* ``process_file`` : permet de s'assurer qu'un fichier est bien complet et décompresse les éventuelles archives
* ``base64_encode`` : permet d'encoder une chaîne de caractères en base 64
* ``base64_decode`` : permet de décoder une chaîne de caractères en base 64
* ``short_identifier`` : permet de générer un identifiant "unique" court
* ``json_encode`` : permet de sérialiser un objet Python en JSON
* ``json_decode`` : permet de désérialiser une chaîne de caractères JSON en objet Python
* ``get_current_user`` : permet de récupérer l'utilisateur actuellement connecté dans la pile d'exécution
* ``get_pk_field`` : permet de récupérer le champ de clé primaire d'un modèle en héritage concret
* ``collect_deleted_data`` : permet de récupérer les impacts potentiels d'une suppression d'entité
* ``send_mail`` : permet d'envoyer un email
* ``merge_validation_errors`` : permet de fusionner plusieurs exceptions de validation en une seule
* ``get_all_models`` : récupère tous les modèles enregistrés dans les applications
* ``get_all_permissions`` : récupère toutes les permissions existantes dans les applications
* ``get_models_from_queryset`` : recupère tous les modèles qui ont été traversés par une requête
* ``get_model_permissions`` : récupère toutes les permissions liées à un modèle et à un utilisateur
* ``get_client_ip`` : récupère l'adresse IP du client depuis une requête Django
* ``hash_file`` : calcule la somme de contrôle d'un fichier

##### Autres (``common.admin``)

* ``create_admin`` : permet de créer automatiquement les classes d'administration d'un modèle

### Modèles

Les differents utilitaires de modèles sont définis dans ``common.models``.

* ``CustomGenericForeignKey`` : champ générique qui ne vide pas les propriétés de la clé si l'instance n'existe pas
* ``CustomGenericRelation`` : relation d'une clé étrangère générique qui force la conversion de l'identifiant en texte
* ``MetaData`` : modèle des métadonnées associées aux entités
* ``CommonModel`` : modèle abstrait commun permettant d'accéder aux multiples utilitaires décrits précédemment
* ``Entity`` : modèle commun avec historisation des modifications
* ``PerishableEntity`` : même chose qu'``Entity`` mais se duplicant en cas de modification
* ``History`` : modèle d'historique d'une entité
* ``HistoryField`` : modèle d'historique d'un champ d'une entité
* ``Global`` : modèle point d'entrée global des entités
* ``Webhook`` : modèle de configuration d'un webhook
* ``ServiceUsage`` : modèle d'un historique d'accès à une ressource du site (avec ou sans limitation)
* ``from_dict`` : construit une instance d'un modèle à partir d'un dictionnaire
* ``to_dict`` : appel générique transformant une instance de modèle en dictionnaire
* ``model_to_dict`` : transforme récursivement une instance de modèle en dictionnaire

### Champs de modèles

Les champs de modèle sont définis dans ``common.fields``.

* ``CustomDecimalField`` : champ décimal pour éviter la représentation scientifique des nombres
* ``PickleField`` : champ binaire pour contenir de la donnée Python brute
* ``JsonField`` : champ pour représenter des données JSON (compatible avec les autres SGBD)

### Formulaires

Les utilitaires autour des formulaires sont définis dans ``common.forms``. Chaque classe utilitaire pour les
formulaires possède une interface de base, préfixée généralement ``Base`` pour d'autres implémentations.

* ``CommonForm`` : classe de base pour les formulaires avec gestion des historiques
* ``CommonFormSet`` : classe de base pour les ensembles de formulaires avec gestion des historiques
* ``CommonModelForm`` : classe de base pour représenter les formulaires issus d'entités
* ``CommonModelFormSet`` : classe de base pour représenter les ensembles de formulaires issus d'entités
* ``JsonField`` : champ de formulaire pour représenter les données JSON
* ``BaseFilterForm`` : classe de base pour faciliter la création de formulaires de recherche
* ``get_model_form`` : fonction permettant de créer un formulaire d'entité avec des imbrications

# Django REST Framework

## Usage

La boîte à outils vous permet de générer rapidement des APIs RESTful pour vos modèles de base de données en leur
fournissant au passage le moyen de faire des requêtes plus évoluées via l'URL. Cette génération s'adresse
principalement aux développeurs qui ont besoin d'accéder à toute la richesse de leurs modèles et de l'ORM Django
via les APIs le plus rapidement possible sans avoir à configurer finement chaque ressource.

### Configuration rapide

Dans votre application Django, créez un nouveau module et ajoutez ces quelques lignes :

```python
from common.api.utils import create_api
from myapp.models import ModelA, ModelB

namespace = "myapp-api"
app_name = "myapp-api"
router, all_serializers, all_viewsets = create_api(ModelA, ModelB)
urlpatterns = [
    # Vos URLs d'API personnalisées    
] + router.urls
urls = (urlpatterns, namespace, app_name)
```

Cela a pour conséquence de créer automatiquement les APIs pour les modèles que vous souhaitez ainsi que la table de
routage nécessaire pour accéder à ces ressources.

De nombreuses options de configuration existent pour vos APIs, vous pouvez par exemple définir précisément le
serialiseur pour chaque modèle, configurer la récupération automatique des entités liées par clé étrangère (related) ou
des relations de type plusieurs-à-plusieurs (prefetch) ou personnaliser les requêtes.

Pour configurer globalement et de manière homogène vos modèles, modifiez les paramètres dans ``common.api.base``.

### Guide d'utilisation rapide



## Utilitaires

* ``to_model_serializer`` : décorateur permettant de convertir un sérialiseur classique en sérialiseur de modèle
* ``to_model_viewset`` : décorateur permettant d'associer un modèle et à un sérialiseur à une vue
* ``create_model_serializer_and_viewset`` : permet de créer en une fois le sérialiseur et la vue pour un modèle
* ``perishable_view`` : permet de gérer les données périssables d'une vue à travers l'URL
* ``api_view_with_serializer`` : décorateur permettant de créer une vue assujettie à un sérialiseur
* ``create_model_serializer`` : permet de créer un sérialiseur de modèle
* ``auto_view`` : décorateur permettant de créer une vue à partir d'un QuerySet
* ``api_paginate`` : permet d'ajouter une pagination sur le résultat d'une requête pour une vue
* ``create_api`` : permet de créer les APIs standards (RESTful) pour un ou plusieurs modèles
* ``disable_relation_fields`` : permet de désactiver les listes déroulantes pour les relations des APIs

##### Sérialiseurs (``common.api.serializers``)

* ``CommonModelSerializer`` : sérialiseur commun pour représenter les entités
* ``GenericFormSerializer`` : sérialiseur permettant l'imbrication d'entités pour les formulaires

##### Champs (``common.api.fields``)

* ``JsonField`` : champ permettant la gestion des données JSON
* ``AsymetricRelatedField`` : champ permettant l'affichage de l'ensemble des données des entités de clés étrangères
mais accepte néanmoins un simple identifiant à la création/modification
* ``CustomHyperlinkedField`` : champ permettant de gérer les liens vers d'autres APIs en permettant de croiser
les différents namespaces (utilisé par défaut par les utilitaires)

##### Pagination (``common.api.pagination``)

* ``CustomPageNumberPagination`` : pagination améliorée pour les APIs 
(doit être défini dans ``DEFAULT_PAGINATION_CLASS`` de ``REST_FRAMEWORK``)

##### Rendu (``common.api.renderers``)

* ``CustomCSVRenderer`` : rendu CSV amélioré avec téléchargement (uniquement si django-rest-framework-csv est installé,
doit être défini dans ``DEFAULT_RENDERER_CLASSES`` de ``REST_FRAMEWORK``)

##### Tests (``common.tests``)

* ``BaseApiTestCase`` : classe de base pour les tests unitaires des APIs
* ``AuthenticatedBaseApiTestCase`` : classe de base pour les tests unitaires des APIs avec authentification
* ``create_api_test_class`` : fonction pour générer tous les tests d'une API standard (RESTful)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "common-framework",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Marc Debureaux <marc@debureaux.fr>",
    "download_url": "https://files.pythonhosted.org/packages/ee/6e/60a36dd6cb8714281e22b1b43ed1d477c35f373860103d7849ec7e70c774/common_framework-2024.3.1.tar.gz",
    "platform": null,
    "description": "# Framework commun\n\nBo\u00eete \u00e0 outils commune pour des d\u00e9veloppements autour de Django (https://www.djangoproject.com/) et \nDjango REST Framework (http://www.django-rest-framework.org/).\n\n## Django\n\n### Entit\u00e9s\n\nUne entit\u00e9 est un super-mod\u00e8le Django offrant un nombre important de nouvelles fonctionnalit\u00e9s tels que l'historisation\ndes donn\u00e9es, la r\u00e9version, les m\u00e9tadonn\u00e9es, la s\u00e9rialisation et la repr\u00e9sentation des donn\u00e9es sous forme de\ndictionnaire.\n\nPour utiliser ces fonctionnalit\u00e9s, il est n\u00e9cessaire de faire h\u00e9riter chaque mod\u00e8le de ``common.models.Entity`` qui\nh\u00e9rite lui-m\u00eame de ``django.db.models.Model``.\n\n```python\nfrom common.models import Entity\n\nclass Personne(Entity):\n    pass\n```\n\nLes mod\u00e8les entit\u00e9s poss\u00e8dent par d\u00e9faut les champs suivants :\n* ``creation_date`` : date de cr\u00e9ation de l'entit\u00e9\n* ``modification_date`` : date de derni\u00e8re modification de l'entit\u00e9\n* ``current_user`` : dernier utilisateur \u00e0 l'origine de la cr\u00e9ation/modification\n* ``uuid`` : identifiant unique de l'entit\u00e9\n\nL'identifiant unique permet de retrouver n'importe quelle entit\u00e9 depuis la base de donn\u00e9es car chacune est\nenregistr\u00e9e dans un r\u00e9f\u00e9rentiel global conjointement \u00e0 son type. Il est donc possible de r\u00e9cup\u00e9rer une entit\u00e9 ainsi :\n\n```python\nfrom common.models import Global\n\nentity = Global.objects.from_uuid('4b9abebd-8157-4e49-bcae-1a7e063a9f86')\n```\n\n> Attention ! Les entit\u00e9s surchargent les m\u00e9thodes de persistance par d\u00e9faut de Django \n(``save()``, ``create()``, ``delete()``).\n``update()`` garde cependant son comportement par d\u00e9faut car il ex\u00e9cute directement la mise \u00e0 jour en base de \ndonn\u00e9es, il sera donc impossible de d\u00e9tecter les changements si elle est utilis\u00e9e.\n\nUne version all\u00e9g\u00e9e d'entit\u00e9 est \u00e0 disposition sans l'historisation ni le r\u00e9f\u00e9rentiel global, il suffit alors\nd'h\u00e9riter les mod\u00e8les de ``common.models.CommonModel`` \u00e0 la place de ``common.models.Entity``.\n\n### Entit\u00e9s p\u00e9rissables\n\nUne entit\u00e9 p\u00e9rissable poss\u00e8de une dur\u00e9e de validit\u00e9 dans le temps, elle poss\u00e8de les m\u00eames fonctionnalit\u00e9s que l'entit\u00e9\nmais poss\u00e8de en prime une date de d\u00e9but (``start_date``) et une date de fin potentielle (``end_date``).\n\nPour d\u00e9finir une entit\u00e9 p\u00e9rissable, il suffit de faire h\u00e9riter le mod\u00e8le de ``common.models.PerishableEntity`` au lieu\nde ``common.models.Entity``. Il n'existe pas d'alternative simplifi\u00e9e hors historisation des entit\u00e9s p\u00e9rissables.\n\nLorsqu'une entit\u00e9 p\u00e9rissable existante en base de donn\u00e9es est sauvegard\u00e9e, le m\u00e9canisme suivant s'ex\u00e9cute :\n* si une date de fin est fournie, l'entit\u00e9 courante est modifi\u00e9e et cl\u00f4tur\u00e9e \u00e0 cette date\n* sans date de fin fournie, l'entit\u00e9 courante est cl\u00f4tur\u00e9e \u00e0 cette date et une autre entit\u00e9 avec les modifications est \ncr\u00e9\u00e9e avec une date de d\u00e9but actualis\u00e9e et sans date de fin programm\u00e9e\n\nLes entit\u00e9s p\u00e9rissables impl\u00e9mentent une fonction de r\u00e9cup\u00e9ration des donn\u00e9es par rapport \u00e0 une date donn\u00e9e, si la date\nn'est pas fournie la requ\u00eate r\u00e9cup\u00e9rera toutes les entit\u00e9s qui sont valides par rapport \u00e0 la date et heure courante.\n\n```python\nadresses = Adresse.objects.filter(personne_id=1).select_valid(date='2016-08-01T00:00:00')\n```\n\n### Administration\n\nAfin de garantir les fonctionnalit\u00e9s de l'historisation dans l'interface  d'administration, il est n\u00e9cessaire de faire\nh\u00e9riter les classes d'administration de ``common.admin.EntityAdmin`` qui permet les fonctionnalit\u00e9s suivantes :\n\n* G\u00e8re automatiquement l'utilisateur connect\u00e9 pour les modifications\n* Affiche automatiquement la date de cr\u00e9ation et de modification et fournit les filtres de recherche\n* G\u00e8re les permissions d'affichage\n* Affiche les m\u00e9tadonn\u00e9es de l'entit\u00e9\n\nPour les entit\u00e9s p\u00e9rissables, il convient d'utiliser ``common.admin.PerishableEntityAdmin`` \u00e0 la place de\n``common.admin.EntityAdmin``.\n\nPour les inlines, des \u00e9quivalents pour les entit\u00e9s sont \u00e9galement \u00e0 disposition : \n``common.admin.EntityTabularInline`` et ``common.admin.EntityStackedInline``.\n\nUne version all\u00e9g\u00e9e existe pour ``common.models.CommonModel`` qui est ``common.admin.CommonAdmin`` qui impl\u00e9mente\nl'ensemble des fonctionnalit\u00e9s en dehors de l'historisation.\n\n### Historisation\n\nToute alt\u00e9ration au niveau des donn\u00e9es d'un mod\u00e8le entit\u00e9 est d\u00e9tect\u00e9e et enregistr\u00e9e dans un historique,\ncela permet un suivi des modifications par utilisation ainsi que la possibilit\u00e9 de revenir \u00e0 un \u00e9tat ant\u00e9rieur pour\nl'entit\u00e9 ou un champ sp\u00e9cifique de l'entit\u00e9.\n\nA chaque modification, un historique d'entit\u00e9 (``common.models.History``) est sauvegard\u00e9 pour l'entit\u00e9 et un \u00e9l\u00e9ment \npar champ modifi\u00e9 dans l'historique (``common.models.HistoryField``) uniquement s'il s'agit d'une modification.\n\n* Les relations de type many-to-many sont trait\u00e9s s\u00e9par\u00e9ment \u00e0 l'historisation.\n* Si Celery est install\u00e9 (http://www.celeryproject.org/), l'historisation est ex\u00e9cut\u00e9e de mani\u00e8re asynchrone.\n* L'utilisateur \u00e0 l'origine de la modification est conserv\u00e9 dans l'historique.\n* Il est possible d'ajouter un message et/ou modifier l'utilisateur \u00e0 l'historique via le code.\n\n```python\npersonne = Personne(nom='Marc', age=30)\npersonne.save(_current_user=utilisateur, _reason=\"Message d'information\")\n```\n\nIl est possible sur un historique d'entit\u00e9 ou un historique de champ de demander une restauration des donn\u00e9es de\nl'historique cibl\u00e9 sur l'entit\u00e9 concern\u00e9e gr\u00e2ce \u00e0 la m\u00e9thode ```restore()```, il est possible de lui passer\n\u00e9galement un utilisateur et un message d'information.\n\nLa restauration provoque elle-m\u00eame un historique sp\u00e9cifique qui permet de revenir en arri\u00e8re si n\u00e9cessaire.\n\n```python\nhistory.restore(current_user=utilisateur, reason=\"Message d'information\", rollback=False)\n# rollback permet de reg\u00e9n\u00e9rer compl\u00e8tement l'entit\u00e9 si elle a \u00e9t\u00e9 supprim\u00e9e\n```\n\n### M\u00e9tadonn\u00e9es\n\nLes m\u00e9tadonn\u00e9es permettent d'ajouter des donn\u00e9es tierces sur une entit\u00e9, ces donn\u00e9es peuvent \u00eatre structur\u00e9es comme\nl'utilisateur le souhaitera et seront stock\u00e9es sous forme de JSON dans la base de donn\u00e9es. Chaque entit\u00e9 poss\u00e8de des\nm\u00e9thodes permettant d'acc\u00e9der aux m\u00e9tadonn\u00e9es de l'entit\u00e9.\n\nLes donn\u00e9es stock\u00e9es dans les m\u00e9tadonn\u00e9es peuvent \u00eatre de n'importe quel type Python \u00e0 condition que ce dernier ainsi\nque les donn\u00e9es qu'il contient \u00e9ventuellement soient s\u00e9rialisables (list, dict, int, float, etc...).\n\n```python\npersonne.set_metadata('cle', 'valeur')\npersonne.get_metadata('cle')\n>>> 'valeur'\npersonne.del_metadata('cle')\npersonne.get_metadata('cle')\n>>> None\n```\n\nLes m\u00e9tadonn\u00e9es d'une entit\u00e9 peuvent \u00eatre directement utilis\u00e9es dans des requ\u00eates m\u00eame si ce n'est pas recommand\u00e9 pour\ndes raisons de performances (en fonction du volume de donn\u00e9es).\nElles sont repr\u00e9sent\u00e9es sous forme d'un mod\u00e8le Django ``common.models.MetaData``.\n\n```python\nPersonne.objects.filter(metadata__key='cle', metadata__value='valeur').first()\nMetaData.objects.search(key='cle', value='valeur', type=Personne)\n```\n\n### S\u00e9rialisation\n\nChaque entit\u00e9 ou requ\u00eate concernant une entit\u00e9 peut \u00eatre s\u00e9rialis\u00e9e en utilisant la m\u00e9thode \n``serialize(format='json')`` dans l'un des formats suivants:\n* JSON\n* XML\n* YAML\n\n```python\npersonne = Personne.objects.first()\nresultat = personne.serialize()\nresultat\n>>> [json] Personne (1)\nresultat.data\n>>> '[{\"nom\": \"Marc\", \"age\": 30}]'\npersonne = resultat.deserialize()\npersonne\n>>> Personne: Marc (30 ans)\n```\n\n```python\npersonnes = Personne.objects.all()\nresultat = personnes.serialize()\nresultat\n>>> [json] Personne (2)\nresultat.data\n>>> '[{\"nom\": \"Marc\", \"age\": 30}, {\"nom\": \"Eric\", \"age\": 40}]'\npersonnes = resultat.deserialize()\npersonnes\n>>> [Personne: Marc (30 ans), Personne: Eric (40 ans)]\n```\n\n### Repr\u00e9sentation en dictionnaire\n\nUne requ\u00eate ou une entit\u00e9 peut \u00eatre repr\u00e9sent\u00e9e par un dictionnaire Python avec la m\u00e9thode ``to_dict()``.\n\n```python\npersonne.to_dict()\n>>> {\"nom\": \"Marc\", \"age\": 30}\nPersonne.objects.all().to_dict()\n>>> [{\"nom\": \"Marc\", \"age\": 30}, {\"nom\": \"Eric\", \"age\": 40}]\n```\n\n``to_dict()`` prend plusieurs arguments optionnels en param\u00e8tres, la m\u00e9thode est document\u00e9e dans le code.\n\n### Type d'entit\u00e9\n\nDjango conserve syst\u00e9matiquement le type des diff\u00e9rents mod\u00e8les en base de donn\u00e9es, les entit\u00e9s poss\u00e8dent un moyen\nsimple pour r\u00e9cup\u00e9rer ce type sur chaque entit\u00e9 de mani\u00e8re performante et unique.\n\n```python\nPersonne.get_model_type()\n>>> <ContentType: Personne>\npersonne.model_type\n>>> <ContentType: Personne>\n```\n\n### WebHooks\n\nUn webhook est un callback HTTP qui transmet des donn\u00e9es \u00e0 un serveur externe en fonction d'une action \nr\u00e9alis\u00e9e sur l'application. Le r\u00e9cepteur doit \u00eatre en mesure de comprendre le message qui est transmis.\nIl est possible de configurer un webhook qui r\u00e9agit \u00e0 un ou plusieurs actions sur une ou plusieurs entit\u00e9s.\n\nLes actions couvertes sont les suivantes :\n* Cr\u00e9ation\n* Modification\n* Suppression\n* Relations de type many-to-many\n\nUn webhook peut \u00eatre configur\u00e9 pour utiliser une authentification sur le serveur externe si n\u00e9cessaire.\n\nPar d\u00e9faut, le webhook ex\u00e9cute la m\u00e9thode ``to_dict()`` sur l'instance concern\u00e9 avec les param\u00e8tres d\u00e9finis dans\n``NOTIFY_OPTIONS``, mais il est possible de changer ce comportement en d\u00e9finissant une m\u00e9thode ``get_webhook_data`` au\nniveau du mod\u00e8le.\n\nLes notifications des changements par webhook est d\u00e9sactiv\u00e9e par d\u00e9faut et peut \u00eatre activ\u00e9 via ``NOTIFY_CHANGES``.\n\n### Usage de service\n\nL'usage des services permet de compter le nombre de fois o\u00f9 une URL est appel\u00e9e dans l'application par un m\u00eame\nutilisateur et m\u00eame de limiter le nombre d'usages.\n\nLa fonctionnalit\u00e9 est d\u00e9sactiv\u00e9e par d\u00e9faut et peut \u00eatre activ\u00e9e via ``SERVICE_USAGE``. \nIl est \u00e9galement n\u00e9cessaire d'ajouter ``'common.middleware.ServiceUsageMiddleware'`` dans ``MIDDLEWARE_CLASSES``.\n\nConfiguration :\n\n* ``SERVICE_USAGE`` (``False`` par d\u00e9faut) : active ou non la surveillance\n* ``SERVICE_USAGE_LOG_DATA`` (``False`` par d\u00e9faut) : suit \u00e9galement les donn\u00e9es transmisses par les services\n* ``SERVICE_USAGE_LIMIT_ONLY`` (``False`` par d\u00e9faut) : utilise uniquement le syst\u00e8me de restriction des services\n\n### M\u00e9tadonn\u00e9es utilisateurs & groupes\n\nDe la m\u00eame mani\u00e8re que sur les entit\u00e9s, les utilisateurs et les groupes ont la possibilit\u00e9 de conserver de \nl'information contextuelle sous forme de m\u00e9tadonn\u00e9e, cependant le fonctionnement diff\u00e8re car ces mod\u00e8les peuvent \u00eatre\nsubstitu\u00e9s dans le d\u00e9veloppement.\n\nIl s'agit alors d'une relation de type one-to-one syst\u00e9matiquement pr\u00e9sent \u00e0 la cr\u00e9ation d'un nouvel utilisateur ou\nd'un nouveau groupe et poss\u00e9dant un champ de type JSON pour contenir ces donn\u00e9es.\n\n## Utilitaires\n\nUn grand nombre de fonctions, d\u00e9corateurs et classes utilitaires sont \u00e0 disposition des d\u00e9veloppeurs pour acc\u00e9l\u00e9rer la\nproduction de nouvelles fonctionnalit\u00e9s. Ces utilitaires sont regroup\u00e9s dans ``common.utils`` pour tout ce qui est\nrelatif \u00e0 Django et dans ``common.api.utils`` pour tout ce qui est relatif \u00e0 Django REST Framework.\n\n* ``singleton`` : d\u00e9corateur permettant de transformer une classe en singleton\n* ``get_current_app`` : permet de r\u00e9cup\u00e9rer l'application Celery actuelle ou un mock si Celery n'est pas install\u00e9\n* ``parsedate`` : permet d'\u00e9valuer une date dans n'importe quel format\n* ``timeit`` : d\u00e9corateur permettant de calculer le temps d'ex\u00e9cution d'une fonction\n* ``synchronized`` : d\u00e9corateur permettant de rendre thread-safe l'ex\u00e9cution d'une fonction\n* ``temporary_upload`` : d\u00e9corateur permettant \u00e0 une vue de supporter l'import d'un fichier de mani\u00e8re temporaire\n* ``download_file`` : d\u00e9corateur permettant \u00e0 une vue de supporter le t\u00e9l\u00e9chargement d'un fichier\n* ``render_to`` : d\u00e9corateur permettant de simplifier l'\u00e9criture d'une vue avec template\n* ``ajax_request`` : d\u00e9corateur permettant \u00e0 une vue de se comporter comme une api_view\n* ``evaluate`` : permet d'\u00e9valuer une expression Python de mani\u00e8re plus s\u00fbre\n* ``execute`` : permet d'ex\u00e9cuter du code Python de mani\u00e8re plus s\u00fbre\n* ``patch_settings`` : context manager permettant d'alt\u00e9rer la configuration le temps de l'ex\u00e9cution\n* ``recursive_dict_product`` : permet de faire un produit cart\u00e9sien des donn\u00e9es d'un dictionnaire\n* ``get_choices_fields`` : permet de r\u00e9cup\u00e9rer les choix des mod\u00e8les d'une ou plusieurs applications\n* ``get_prefetchs`` : permet de r\u00e9cup\u00e9rer toutes les relations invers\u00e9es d'un mod\u00e8le\n* ``get_related`` : permet de r\u00e9cup\u00e9rer toutes les relations ascendantes d'un mod\u00e8le\n* ``prefetch_generics`` : permet de r\u00e9cup\u00e9rer les relations g\u00e9n\u00e9riques d'un mod\u00e8le\n* ``str_to_bool`` : permet de convertir une cha\u00eene de caract\u00e8res quelconque en bool\u00e9en\n* ``decimal`` : permet de convertir un \u00e9l\u00e9ment quelconque en nombre d\u00e9cimal\n* ``decimal_to_str`` : permet de convertir un nombre d\u00e9cimal en cha\u00eene de caract\u00e8res\n* ``recursive_get_urls`` : permet de r\u00e9cup\u00e9rer toutes les URLs d'un module\n* ``idict`` : dictionnaire donc les cl\u00e9s sont toujours converties dans un format uniforme\n* ``sort_dict`` : permet de trier un dictionnaire par ses cl\u00e9s\n* ``merge_dict`` : permet de fusionner un ou plusieurs dictionnaires imbriqu\u00e9s sur un autre\n* ``null`` : objet nul absolu retournant toujours une valeur nulle sans erreur\n* ``to_tuple`` : permet de convertir un dictionnaire en un tuple\n* ``to_object`` : permet de convertir un dictionnaire en un objet Python\n* ``get_size`` : permet de r\u00e9cup\u00e9rer la taille en m\u00e9moire d'un objet Python quelconque\n* ``file_is_text`` : permet de v\u00e9rifier qu'un fichier est au format texte\n* ``process_file`` : permet de s'assurer qu'un fichier est bien complet et d\u00e9compresse les \u00e9ventuelles archives\n* ``base64_encode`` : permet d'encoder une cha\u00eene de caract\u00e8res en base 64\n* ``base64_decode`` : permet de d\u00e9coder une cha\u00eene de caract\u00e8res en base 64\n* ``short_identifier`` : permet de g\u00e9n\u00e9rer un identifiant \"unique\" court\n* ``json_encode`` : permet de s\u00e9rialiser un objet Python en JSON\n* ``json_decode`` : permet de d\u00e9s\u00e9rialiser une cha\u00eene de caract\u00e8res JSON en objet Python\n* ``get_current_user`` : permet de r\u00e9cup\u00e9rer l'utilisateur actuellement connect\u00e9 dans la pile d'ex\u00e9cution\n* ``get_pk_field`` : permet de r\u00e9cup\u00e9rer le champ de cl\u00e9 primaire d'un mod\u00e8le en h\u00e9ritage concret\n* ``collect_deleted_data`` : permet de r\u00e9cup\u00e9rer les impacts potentiels d'une suppression d'entit\u00e9\n* ``send_mail`` : permet d'envoyer un email\n* ``merge_validation_errors`` : permet de fusionner plusieurs exceptions de validation en une seule\n* ``get_all_models`` : r\u00e9cup\u00e8re tous les mod\u00e8les enregistr\u00e9s dans les applications\n* ``get_all_permissions`` : r\u00e9cup\u00e8re toutes les permissions existantes dans les applications\n* ``get_models_from_queryset`` : recup\u00e8re tous les mod\u00e8les qui ont \u00e9t\u00e9 travers\u00e9s par une requ\u00eate\n* ``get_model_permissions`` : r\u00e9cup\u00e8re toutes les permissions li\u00e9es \u00e0 un mod\u00e8le et \u00e0 un utilisateur\n* ``get_client_ip`` : r\u00e9cup\u00e8re l'adresse IP du client depuis une requ\u00eate Django\n* ``hash_file`` : calcule la somme de contr\u00f4le d'un fichier\n\n##### Autres (``common.admin``)\n\n* ``create_admin`` : permet de cr\u00e9er automatiquement les classes d'administration d'un mod\u00e8le\n\n### Mod\u00e8les\n\nLes differents utilitaires de mod\u00e8les sont d\u00e9finis dans ``common.models``.\n\n* ``CustomGenericForeignKey`` : champ g\u00e9n\u00e9rique qui ne vide pas les propri\u00e9t\u00e9s de la cl\u00e9 si l'instance n'existe pas\n* ``CustomGenericRelation`` : relation d'une cl\u00e9 \u00e9trang\u00e8re g\u00e9n\u00e9rique qui force la conversion de l'identifiant en texte\n* ``MetaData`` : mod\u00e8le des m\u00e9tadonn\u00e9es associ\u00e9es aux entit\u00e9s\n* ``CommonModel`` : mod\u00e8le abstrait commun permettant d'acc\u00e9der aux multiples utilitaires d\u00e9crits pr\u00e9c\u00e9demment\n* ``Entity`` : mod\u00e8le commun avec historisation des modifications\n* ``PerishableEntity`` : m\u00eame chose qu'``Entity`` mais se duplicant en cas de modification\n* ``History`` : mod\u00e8le d'historique d'une entit\u00e9\n* ``HistoryField`` : mod\u00e8le d'historique d'un champ d'une entit\u00e9\n* ``Global`` : mod\u00e8le point d'entr\u00e9e global des entit\u00e9s\n* ``Webhook`` : mod\u00e8le de configuration d'un webhook\n* ``ServiceUsage`` : mod\u00e8le d'un historique d'acc\u00e8s \u00e0 une ressource du site (avec ou sans limitation)\n* ``from_dict`` : construit une instance d'un mod\u00e8le \u00e0 partir d'un dictionnaire\n* ``to_dict`` : appel g\u00e9n\u00e9rique transformant une instance de mod\u00e8le en dictionnaire\n* ``model_to_dict`` : transforme r\u00e9cursivement une instance de mod\u00e8le en dictionnaire\n\n### Champs de mod\u00e8les\n\nLes champs de mod\u00e8le sont d\u00e9finis dans ``common.fields``.\n\n* ``CustomDecimalField`` : champ d\u00e9cimal pour \u00e9viter la repr\u00e9sentation scientifique des nombres\n* ``PickleField`` : champ binaire pour contenir de la donn\u00e9e Python brute\n* ``JsonField`` : champ pour repr\u00e9senter des donn\u00e9es JSON (compatible avec les autres SGBD)\n\n### Formulaires\n\nLes utilitaires autour des formulaires sont d\u00e9finis dans ``common.forms``. Chaque classe utilitaire pour les\nformulaires poss\u00e8de une interface de base, pr\u00e9fix\u00e9e g\u00e9n\u00e9ralement ``Base`` pour d'autres impl\u00e9mentations.\n\n* ``CommonForm`` : classe de base pour les formulaires avec gestion des historiques\n* ``CommonFormSet`` : classe de base pour les ensembles de formulaires avec gestion des historiques\n* ``CommonModelForm`` : classe de base pour repr\u00e9senter les formulaires issus d'entit\u00e9s\n* ``CommonModelFormSet`` : classe de base pour repr\u00e9senter les ensembles de formulaires issus d'entit\u00e9s\n* ``JsonField`` : champ de formulaire pour repr\u00e9senter les donn\u00e9es JSON\n* ``BaseFilterForm`` : classe de base pour faciliter la cr\u00e9ation de formulaires de recherche\n* ``get_model_form`` : fonction permettant de cr\u00e9er un formulaire d'entit\u00e9 avec des imbrications\n\n# Django REST Framework\n\n## Usage\n\nLa bo\u00eete \u00e0 outils vous permet de g\u00e9n\u00e9rer rapidement des APIs RESTful pour vos mod\u00e8les de base de donn\u00e9es en leur\nfournissant au passage le moyen de faire des requ\u00eates plus \u00e9volu\u00e9es via l'URL. Cette g\u00e9n\u00e9ration s'adresse\nprincipalement aux d\u00e9veloppeurs qui ont besoin d'acc\u00e9der \u00e0 toute la richesse de leurs mod\u00e8les et de l'ORM Django\nvia les APIs le plus rapidement possible sans avoir \u00e0 configurer finement chaque ressource.\n\n### Configuration rapide\n\nDans votre application Django, cr\u00e9ez un nouveau module et ajoutez ces quelques lignes :\n\n```python\nfrom common.api.utils import create_api\nfrom myapp.models import ModelA, ModelB\n\nnamespace = \"myapp-api\"\napp_name = \"myapp-api\"\nrouter, all_serializers, all_viewsets = create_api(ModelA, ModelB)\nurlpatterns = [\n    # Vos URLs d'API personnalis\u00e9es    \n] + router.urls\nurls = (urlpatterns, namespace, app_name)\n```\n\nCela a pour cons\u00e9quence de cr\u00e9er automatiquement les APIs pour les mod\u00e8les que vous souhaitez ainsi que la table de\nroutage n\u00e9cessaire pour acc\u00e9der \u00e0 ces ressources.\n\nDe nombreuses options de configuration existent pour vos APIs, vous pouvez par exemple d\u00e9finir pr\u00e9cis\u00e9ment le\nserialiseur pour chaque mod\u00e8le, configurer la r\u00e9cup\u00e9ration automatique des entit\u00e9s li\u00e9es par cl\u00e9 \u00e9trang\u00e8re (related) ou\ndes relations de type plusieurs-\u00e0-plusieurs (prefetch) ou personnaliser les requ\u00eates.\n\nPour configurer globalement et de mani\u00e8re homog\u00e8ne vos mod\u00e8les, modifiez les param\u00e8tres dans ``common.api.base``.\n\n### Guide d'utilisation rapide\n\n\n\n## Utilitaires\n\n* ``to_model_serializer`` : d\u00e9corateur permettant de convertir un s\u00e9rialiseur classique en s\u00e9rialiseur de mod\u00e8le\n* ``to_model_viewset`` : d\u00e9corateur permettant d'associer un mod\u00e8le et \u00e0 un s\u00e9rialiseur \u00e0 une vue\n* ``create_model_serializer_and_viewset`` : permet de cr\u00e9er en une fois le s\u00e9rialiseur et la vue pour un mod\u00e8le\n* ``perishable_view`` : permet de g\u00e9rer les donn\u00e9es p\u00e9rissables d'une vue \u00e0 travers l'URL\n* ``api_view_with_serializer`` : d\u00e9corateur permettant de cr\u00e9er une vue assujettie \u00e0 un s\u00e9rialiseur\n* ``create_model_serializer`` : permet de cr\u00e9er un s\u00e9rialiseur de mod\u00e8le\n* ``auto_view`` : d\u00e9corateur permettant de cr\u00e9er une vue \u00e0 partir d'un QuerySet\n* ``api_paginate`` : permet d'ajouter une pagination sur le r\u00e9sultat d'une requ\u00eate pour une vue\n* ``create_api`` : permet de cr\u00e9er les APIs standards (RESTful) pour un ou plusieurs mod\u00e8les\n* ``disable_relation_fields`` : permet de d\u00e9sactiver les listes d\u00e9roulantes pour les relations des APIs\n\n##### S\u00e9rialiseurs (``common.api.serializers``)\n\n* ``CommonModelSerializer`` : s\u00e9rialiseur commun pour repr\u00e9senter les entit\u00e9s\n* ``GenericFormSerializer`` : s\u00e9rialiseur permettant l'imbrication d'entit\u00e9s pour les formulaires\n\n##### Champs (``common.api.fields``)\n\n* ``JsonField`` : champ permettant la gestion des donn\u00e9es JSON\n* ``AsymetricRelatedField`` : champ permettant l'affichage de l'ensemble des donn\u00e9es des entit\u00e9s de cl\u00e9s \u00e9trang\u00e8res\nmais accepte n\u00e9anmoins un simple identifiant \u00e0 la cr\u00e9ation/modification\n* ``CustomHyperlinkedField`` : champ permettant de g\u00e9rer les liens vers d'autres APIs en permettant de croiser\nles diff\u00e9rents namespaces (utilis\u00e9 par d\u00e9faut par les utilitaires)\n\n##### Pagination (``common.api.pagination``)\n\n* ``CustomPageNumberPagination`` : pagination am\u00e9lior\u00e9e pour les APIs \n(doit \u00eatre d\u00e9fini dans ``DEFAULT_PAGINATION_CLASS`` de ``REST_FRAMEWORK``)\n\n##### Rendu (``common.api.renderers``)\n\n* ``CustomCSVRenderer`` : rendu CSV am\u00e9lior\u00e9 avec t\u00e9l\u00e9chargement (uniquement si django-rest-framework-csv est install\u00e9,\ndoit \u00eatre d\u00e9fini dans ``DEFAULT_RENDERER_CLASSES`` de ``REST_FRAMEWORK``)\n\n##### Tests (``common.tests``)\n\n* ``BaseApiTestCase`` : classe de base pour les tests unitaires des APIs\n* ``AuthenticatedBaseApiTestCase`` : classe de base pour les tests unitaires des APIs avec authentification\n* ``create_api_test_class`` : fonction pour g\u00e9n\u00e9rer tous les tests d'une API standard (RESTful)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "All-in-one framework for Django and Django REST Framework",
    "version": "2024.3.1",
    "project_urls": {
        "Homepage": "https://github.com/debnet/common-framework"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "0faa4f01f8f21a05e957a6b78ad8edfafaaa02f9fb66c2e145227d8a21a1119d",
                "md5": "681d442168d69e40c39ff3aed7fca3b6",
                "sha256": "e64ba84d0e3f612f466bfb09e29582d45a220b4f9112a117113f52b4edbdceec"
            },
            "downloads": -1,
            "filename": "common_framework-2024.3.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "681d442168d69e40c39ff3aed7fca3b6",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 152143,
            "upload_time": "2024-03-19T21:32:05",
            "upload_time_iso_8601": "2024-03-19T21:32:05.195795Z",
            "url": "https://files.pythonhosted.org/packages/0f/aa/4f01f8f21a05e957a6b78ad8edfafaaa02f9fb66c2e145227d8a21a1119d/common_framework-2024.3.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ee6e60a36dd6cb8714281e22b1b43ed1d477c35f373860103d7849ec7e70c774",
                "md5": "7659a1b076470f812afe36e54f698141",
                "sha256": "17399373ce06c2a56611c6f1665fe735336e59568358787808e5ad0269f3a178"
            },
            "downloads": -1,
            "filename": "common_framework-2024.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7659a1b076470f812afe36e54f698141",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 124509,
            "upload_time": "2024-03-19T21:32:08",
            "upload_time_iso_8601": "2024-03-19T21:32:08.296698Z",
            "url": "https://files.pythonhosted.org/packages/ee/6e/60a36dd6cb8714281e22b1b43ed1d477c35f373860103d7849ec7e70c774/common_framework-2024.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-19 21:32:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "debnet",
    "github_project": "common-framework",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "Django",
            "specs": [
                [
                    "==",
                    "5.0.3"
                ]
            ]
        },
        {
            "name": "Pillow",
            "specs": [
                [
                    "==",
                    "10.2.0"
                ]
            ]
        },
        {
            "name": "PyYAML",
            "specs": [
                [
                    "==",
                    "6.0.1"
                ]
            ]
        },
        {
            "name": "celery",
            "specs": [
                [
                    "==",
                    "5.3.6"
                ]
            ]
        },
        {
            "name": "djangorestframework",
            "specs": [
                [
                    "==",
                    "3.15.0"
                ]
            ]
        },
        {
            "name": "flake8",
            "specs": [
                [
                    "==",
                    "7.0.0"
                ]
            ]
        },
        {
            "name": "model-bakery",
            "specs": [
                [
                    "==",
                    "1.17.0"
                ]
            ]
        },
        {
            "name": "python-dateutil",
            "specs": [
                [
                    "==",
                    "2.8.2"
                ]
            ]
        },
        {
            "name": "pip",
            "specs": [
                [
                    "==",
                    "24.0"
                ]
            ]
        },
        {
            "name": "psycopg",
            "specs": [
                [
                    "==",
                    "3.1.18"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.31.0"
                ]
            ]
        },
        {
            "name": "setuptools",
            "specs": [
                [
                    "==",
                    "69.2.0"
                ]
            ]
        },
        {
            "name": "uritemplate",
            "specs": [
                [
                    "==",
                    "4.1.1"
                ]
            ]
        },
        {
            "name": "wheel",
            "specs": [
                [
                    "==",
                    "0.43.0"
                ]
            ]
        }
    ],
    "lcname": "common-framework"
}
        
Elapsed time: 0.30344s