# Paquete de Repositorio de Zibanu para Django - zibanu.django.repository package
Este sistema permite gestionar un repositorio de archivos y generar PDFs a partir de templates HTML, almacenándolos dentro del proyecto de Django y registrando la información sobre cada PDF en la tabla del repositorio, teniendo en cuenta que, se asigna una clave UUID (Universally Unique Identifier) a cada PDF generado con el fin de identificar el archivo en el repositorio.
## zibanu.django.repository.lib.managers package
Este paquete contiene la clase *Administrador de documentos.*
## zibanu.django.repository.lib.managers.document module
```
class zibanu.django.repository.lib.managers.document.Document()
```
El administrador de documentos es una clase que proporciona métodos para consultar y administrar documentos.
__________________
**Métodos**
```
get_by_uuid(uuid: str)→ models.QuerySet
```
Toma un UUID como entrada y devuelve un conjunto de consultas de documentos que coinciden con el UUID.
- Parámetros:
*uuid:* Cadena de texto con el valor de UUID.
- Retorna:
*qs:* Queryset con filtro por valor UUID.
__________________
```
get_by_code(code: str)→ models.QuerySet
```
Toma un código como entrada y devuelve un conjunto de consultas de documentos que coinciden con el código.
- Parámetros:
*code:* Cadena de texto con el valor del código.
- Retorna:
*qs:* Queryset con filtro por valor UUID.
## zibanu.django.repository.lib.utils package
Este paquete contiene la clase *Generador de documentos.*
## zibanu.django.repository.lib.utils.document_generator module
```
class zibanu.django.repository.lib.utils.document_generator.DocumentGenerator(template_prefix: str, custom_dir: str = None)→ None
```
Clase de Python que genera un nuevo documento PDF a partir de una definición de plantilla de Django.
- Parámetros:
*template_prefix:* Ruta al directorio donde se encuentran las plantillas
*custom_dir:* Directorio personalizado donde se guardarán los documentos PDF generados.
__________________
**Métodos**
```
generate_from_template(template_name: str, context: dict, **kwargs)→ str:
```
Método para generar un documento a partir de una plantilla de django.
- Parámetros:
*template_name:* Nombre de la plantilla para construir el documento pdf.
*context:* Diccionario de contexto para anular el constructor de contexto.
*kwargs:* Diccionario con vars a plantilla como "descripción", "solicitud", "clave" y "usuario". El usuario es obligatorio.
- Retorna:
*hex:* Cadena de texto con UUID hexadecimal del documento generado.
__________________
```
get_file(user, **kwargs)→ str:
```
Obtiene un nombre de la ruta de archivo del filtrado de documentos del usuario (Obligatorio) y los valores de código o UUID.
- Parámetros:
*kwargs:* Diccionario con claves y valores para la construcción de filtros.
- Retorna:
*document:* Objeto de documento que coincide con el filtro.
__________________
```
get_document(**kwargs)→ Document:
```
Obtiene un documento de filtros definidos en **kwargs
- Parámetros:
*kwargs:* Diccionario con claves y valores para la construcción de filtros.
- Retorna:
*document:* Objeto de documento que coincide con el filtro.
## zibanu.django.repository.apps module
```
class zibanu.django.repository.apps.ZbDjangoRepository(app_name, app_module)
```
Clase heredada de django.apps.AppConfig para definir la configuración de la aplicación zibanu.django.repository.
__________________
**Atributos**
Este atributo se establece en 'django.db.models.BigAutoField', que es el campo automático predeterminado para los modelos de Django.
```
default_auto_field = 'django.db.models.BigAutoField'
```
__________________
Este atributo se establece en "zibanu.django.repository", que es el nombre de la aplicación.
```
name = "zibanu.django.repository"
```
__________________
Este atributo se establece en "zb_repository", que es la etiqueta de la aplicación.
```
label = "zb_repository"
```
__________________
**Método**
```
ready()
```
Método de anulación utilizado para el cargador de aplicaciones django después de que la aplicación se haya cargado correctamente.
- Retorna:
Ninguno.
- Ajustes:
ZB_REPOSITORY_DIRECTORY: Nombre del directorio para almacenar los documentos generados en la ruta MEDIA_ROOT. Predeterminado "ZbRepository"
## zibanu.django.repository.models module
Contiene la clase de modelo de la entidad del documento para almacenar y administrar los datos del documento.
La clase Documento tiene los siguientes campos:
- *code:* Un campo char para almacenar el código de validación.
- *uuid:* Un campo UUID para almacenar el UUID del archivo.
- *owner:* Una clave externa al modelo de usuario para almacenar el propietario del documento.
- *generated_at:* Un campo de fecha y hora para almacenar la fecha y la hora en que se generó el documento.
- *descripción:* Un campo char para almacenar una descripción del documento.
La clase también tiene un administrador predeterminado llamado objects.
```
class zibanu.django.repository.models.Document()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "zibanu-django-repository",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "django, zibanu, library, repository, filemanager, files",
"author": null,
"author_email": "Mario Cer\u00f3n <mario.ceron@cqinversiones.co>",
"download_url": "https://files.pythonhosted.org/packages/e3/f0/51cdfe259d279e7b19a2accc180fff609ed0decc8ef31681d0a2b4e2b2d1/zibanu_django_repository-2.1.3.tar.gz",
"platform": null,
"description": "# Paquete de Repositorio de Zibanu para Django - zibanu.django.repository package\n\nEste sistema permite gestionar un repositorio de archivos y generar PDFs a partir de templates HTML, almacen\u00e1ndolos dentro del proyecto de Django y registrando la informaci\u00f3n sobre cada PDF en la tabla del repositorio, teniendo en cuenta que, se asigna una clave UUID (Universally Unique Identifier) a cada PDF generado con el fin de identificar el archivo en el repositorio.\n\n## zibanu.django.repository.lib.managers package\n\nEste paquete contiene la clase *Administrador de documentos.* \n\n## zibanu.django.repository.lib.managers.document module\n```\nclass zibanu.django.repository.lib.managers.document.Document()\n```\n\nEl administrador de documentos es una clase que proporciona m\u00e9todos para consultar y administrar documentos.\n\n__________________\n**M\u00e9todos**\n\n```\nget_by_uuid(uuid: str)\u2192 models.QuerySet\n```\nToma un UUID como entrada y devuelve un conjunto de consultas de documentos que coinciden con el UUID.\n\n- Par\u00e1metros:\n\n*uuid:* Cadena de texto con el valor de UUID. \n\n- Retorna:\n\n*qs:* Queryset con filtro por valor UUID.\n\n__________________\n```\nget_by_code(code: str)\u2192 models.QuerySet\n```\n\nToma un c\u00f3digo como entrada y devuelve un conjunto de consultas de documentos que coinciden con el c\u00f3digo.\n\n- Par\u00e1metros:\n\n*code:* Cadena de texto con el valor del c\u00f3digo.\n\n- Retorna:\n\n*qs:* Queryset con filtro por valor UUID.\n\n## zibanu.django.repository.lib.utils package \n\nEste paquete contiene la clase *Generador de documentos.*\n\n## zibanu.django.repository.lib.utils.document_generator module\n\n```\nclass zibanu.django.repository.lib.utils.document_generator.DocumentGenerator(template_prefix: str, custom_dir: str = None)\u2192 None\n```\n\n Clase de Python que genera un nuevo documento PDF a partir de una definici\u00f3n de plantilla de Django.\n\n- Par\u00e1metros:\n\n*template_prefix:* Ruta al directorio donde se encuentran las plantillas\n\n*custom_dir:* Directorio personalizado donde se guardar\u00e1n los documentos PDF generados.\n__________________\n\n**M\u00e9todos**\n\n\n```\ngenerate_from_template(template_name: str, context: dict, **kwargs)\u2192 str:\n```\n\nM\u00e9todo para generar un documento a partir de una plantilla de django.\n\n- Par\u00e1metros:\n\n*template_name:* Nombre de la plantilla para construir el documento pdf.\n\n*context:* Diccionario de contexto para anular el constructor de contexto.\n\n*kwargs:* Diccionario con vars a plantilla como \"descripci\u00f3n\", \"solicitud\", \"clave\" y \"usuario\". El usuario es obligatorio.\n\n- Retorna:\n\n*hex:* Cadena de texto con UUID hexadecimal del documento generado.\n\n__________________\n\n```\nget_file(user, **kwargs)\u2192 str:\n```\n\nObtiene un nombre de la ruta de archivo del filtrado de documentos del usuario (Obligatorio) y los valores de c\u00f3digo o UUID.\n\n- Par\u00e1metros:\n\n*kwargs:* Diccionario con claves y valores para la construcci\u00f3n de filtros.\n\n- Retorna:\n\n*document:* Objeto de documento que coincide con el filtro.\n\n__________________\n\n```\nget_document(**kwargs)\u2192 Document:\n```\nObtiene un documento de filtros definidos en **kwargs\n\n- Par\u00e1metros:\n\n*kwargs:* Diccionario con claves y valores para la construcci\u00f3n de filtros.\n\n- Retorna:\n\n*document:* Objeto de documento que coincide con el filtro.\n\n\n## zibanu.django.repository.apps module\n```\nclass zibanu.django.repository.apps.ZbDjangoRepository(app_name, app_module)\n```\n\nClase heredada de django.apps.AppConfig para definir la configuraci\u00f3n de la aplicaci\u00f3n zibanu.django.repository.\n__________________\n**Atributos**\n\nEste atributo se establece en 'django.db.models.BigAutoField', que es el campo autom\u00e1tico predeterminado para los modelos de Django.\n\n```\ndefault_auto_field = 'django.db.models.BigAutoField'\n```\n__________________\n\nEste atributo se establece en \"zibanu.django.repository\", que es el nombre de la aplicaci\u00f3n.\n```\nname = \"zibanu.django.repository\"\n```\n__________________\n\nEste atributo se establece en \"zb_repository\", que es la etiqueta de la aplicaci\u00f3n.\n```\nlabel = \"zb_repository\"\n```\n__________________\n\n**M\u00e9todo**\n```\nready()\n```\nM\u00e9todo de anulaci\u00f3n utilizado para el cargador de aplicaciones django despu\u00e9s de que la aplicaci\u00f3n se haya cargado correctamente.\n\n- Retorna:\n\nNinguno.\n\n- Ajustes:\n\nZB_REPOSITORY_DIRECTORY: Nombre del directorio para almacenar los documentos generados en la ruta MEDIA_ROOT. Predeterminado \"ZbRepository\"\n\n## zibanu.django.repository.models module\n\nContiene la clase de modelo de la entidad del documento para almacenar y administrar los datos del documento.\n\nLa clase Documento tiene los siguientes campos:\n\n- *code:* Un campo char para almacenar el c\u00f3digo de validaci\u00f3n.\n- *uuid:* Un campo UUID para almacenar el UUID del archivo.\n- *owner:* Una clave externa al modelo de usuario para almacenar el propietario del documento.\n- *generated_at:* Un campo de fecha y hora para almacenar la fecha y la hora en que se gener\u00f3 el documento.\n- *descripci\u00f3n:* Un campo char para almacenar una descripci\u00f3n del documento.\n\nLa clase tambi\u00e9n tiene un administrador predeterminado llamado objects.\n\n```\nclass zibanu.django.repository.models.Document()\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Zibanu repository library for django projects",
"version": "2.1.3",
"project_urls": null,
"split_keywords": [
"django",
" zibanu",
" library",
" repository",
" filemanager",
" files"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9cf257e8187f51f2e99f3b2645b8921d721e5f441ba790ef74ed0296bb620eed",
"md5": "e86e34af6c586289957c1d6fd99fad23",
"sha256": "984cb2a9f3074d37230ba916aed0341139912f319c8b5a895e9b65cdf5b1d70a"
},
"downloads": -1,
"filename": "zibanu_django_repository-2.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e86e34af6c586289957c1d6fd99fad23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 61504,
"upload_time": "2025-07-08T15:43:54",
"upload_time_iso_8601": "2025-07-08T15:43:54.608106Z",
"url": "https://files.pythonhosted.org/packages/9c/f2/57e8187f51f2e99f3b2645b8921d721e5f441ba790ef74ed0296bb620eed/zibanu_django_repository-2.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e3f051cdfe259d279e7b19a2accc180fff609ed0decc8ef31681d0a2b4e2b2d1",
"md5": "8f0252393b2d252ad62cf40d39e01e21",
"sha256": "f791daf313c72badc4ef67e7a0c8d615f0e4ad083933ac4ad945e54f866f1b22"
},
"downloads": -1,
"filename": "zibanu_django_repository-2.1.3.tar.gz",
"has_sig": false,
"md5_digest": "8f0252393b2d252ad62cf40d39e01e21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 42065,
"upload_time": "2025-07-08T15:43:55",
"upload_time_iso_8601": "2025-07-08T15:43:55.500412Z",
"url": "https://files.pythonhosted.org/packages/e3/f0/51cdfe259d279e7b19a2accc180fff609ed0decc8ef31681d0a2b4e2b2d1/zibanu_django_repository-2.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 15:43:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "zibanu-django-repository"
}
JSON