# Chozita
Chozita es una mini librería para encriptar y desencriptar archivos utilizando Fernet como intermediario.
   
### Objetivo de Chozita
El objetivo de Chozita es simplificar el proceso de encriptar archivos para marcos de trabajo como Tkinter.
### Estado Actual
Actualmente, cuenta con dos funciones básicas para trabajar (`cifrar` y `descifrar`). Estas son las implementaciones iniciales de la librería. En futuras versiones, se añadirán más métodos, como la capacidad de distribuir el contenido cifrado en múltiples archivos JSON en lugar de uno solo, y la implementación de compresión ZIP.
#### Instalación
```bash
pip install Chozita
```
#### Explicación de la idea para la implementación con ZIP
El cifrado se realizará como en el formato actual, pero el contenido estará distribuido en múltiples archivos dentro de un archivo ZIP. La función se encargará directamente de descomprimir y leer los archivos internos para descifrarlos y recrear el contenido original.
### Notas
La biblioteca maneja automáticamente los `PATH`. Si se indica cifrar un archivo, por ejemplo: `src/img.jpg`, el archivo JSON que contiene los datos cifrados se creará automáticamente en el mismo `PATH` con el nombre `src/img.json`. Lo mismo ocurre para ambas funciones de cifrado.
### Ejemplo de código
Las funciones devuelven una tupla de datos `[bool, string]`:
- `bool` devuelve `True` si se ejecutó correctamente y `False` si hubo algún error.
- `string` permanece vacío si todo funciona correctamente, pero contiene el mensaje de error si `bool` es `False`.
```python
from Chozita import Chozita
# Crear la instancia
C = Chozita()
# Ejemplo de cifrado y descifrado
CheckValue, ErrorString = C.cifrar('img.jpg', 'password')
if not CheckValue:
print(ErrorString)
CheckValue, ErrorString = C.descifrar('img.json', 'password')
if not CheckValue:
print(ErrorString)
# Ejemplo utilizando rutas específicas
CheckValue, ErrorString = C.cifrar('src/img.jpg', 'password')
if not CheckValue:
print(ErrorString)
CheckValue, ErrorString = C.descifrar('src/img.json', 'password')
if not CheckValue:
print(ErrorString)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/BAA4TS/Chozita",
"name": "Chozita",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Cifrado, Python, Fernet, Automatizaci\u00f3n",
"author": "baaaaa",
"author_email": "devbaats@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/02/ed/52a107d5f7e9fe445318467d2b48c80eb1753175601e37824944547945eb/chozita-1.5.5.tar.gz",
"platform": null,
"description": "# Chozita \r\n\r\nChozita es una mini librer\u00eda para encriptar y desencriptar archivos utilizando Fernet como intermediario.\r\n\r\n\r\n\r\n   \r\n\r\n### Objetivo de Chozita\r\nEl objetivo de Chozita es simplificar el proceso de encriptar archivos para marcos de trabajo como Tkinter.\r\n\r\n### Estado Actual\r\nActualmente, cuenta con dos funciones b\u00e1sicas para trabajar (`cifrar` y `descifrar`). Estas son las implementaciones iniciales de la librer\u00eda. En futuras versiones, se a\u00f1adir\u00e1n m\u00e1s m\u00e9todos, como la capacidad de distribuir el contenido cifrado en m\u00faltiples archivos JSON en lugar de uno solo, y la implementaci\u00f3n de compresi\u00f3n ZIP.\r\n\r\n#### Instalaci\u00f3n\r\n```bash\r\npip install Chozita\r\n```\r\n\r\n#### Explicaci\u00f3n de la idea para la implementaci\u00f3n con ZIP\r\nEl cifrado se realizar\u00e1 como en el formato actual, pero el contenido estar\u00e1 distribuido en m\u00faltiples archivos dentro de un archivo ZIP. La funci\u00f3n se encargar\u00e1 directamente de descomprimir y leer los archivos internos para descifrarlos y recrear el contenido original.\r\n\r\n### Notas\r\nLa biblioteca maneja autom\u00e1ticamente los `PATH`. Si se indica cifrar un archivo, por ejemplo: `src/img.jpg`, el archivo JSON que contiene los datos cifrados se crear\u00e1 autom\u00e1ticamente en el mismo `PATH` con el nombre `src/img.json`. Lo mismo ocurre para ambas funciones de cifrado.\r\n\r\n### Ejemplo de c\u00f3digo\r\nLas funciones devuelven una tupla de datos `[bool, string]`:\r\n- `bool` devuelve `True` si se ejecut\u00f3 correctamente y `False` si hubo alg\u00fan error.\r\n- `string` permanece vac\u00edo si todo funciona correctamente, pero contiene el mensaje de error si `bool` es `False`.\r\n\r\n```python\r\nfrom Chozita import Chozita\r\n\r\n# Crear la instancia\r\nC = Chozita()\r\n\r\n# Ejemplo de cifrado y descifrado\r\nCheckValue, ErrorString = C.cifrar('img.jpg', 'password')\r\nif not CheckValue:\r\n print(ErrorString)\r\n\r\nCheckValue, ErrorString = C.descifrar('img.json', 'password')\r\nif not CheckValue:\r\n print(ErrorString)\r\n\r\n# Ejemplo utilizando rutas espec\u00edficas\r\nCheckValue, ErrorString = C.cifrar('src/img.jpg', 'password')\r\nif not CheckValue:\r\n print(ErrorString)\r\n\r\nCheckValue, ErrorString = C.descifrar('src/img.json', 'password')\r\nif not CheckValue:\r\n print(ErrorString)\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Una mini librer\u00eda de automatizaci\u00f3n de cifrado de archivos",
"version": "1.5.5",
"project_urls": {
"Homepage": "https://github.com/BAA4TS/Chozita"
},
"split_keywords": [
"cifrado",
" python",
" fernet",
" automatizaci\u00f3n"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b1dbb6f801af1be21f37222b18bea1aa4fe3e5826b095320a308fda5ee770637",
"md5": "3aed8551677482600321832ac21251ad",
"sha256": "4f4f865ed7312d70f2fe495306caf05515d57c8008b1ac32a9726cd9cd72f505"
},
"downloads": -1,
"filename": "Chozita-1.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3aed8551677482600321832ac21251ad",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5011,
"upload_time": "2024-07-08T00:51:10",
"upload_time_iso_8601": "2024-07-08T00:51:10.973785Z",
"url": "https://files.pythonhosted.org/packages/b1/db/b6f801af1be21f37222b18bea1aa4fe3e5826b095320a308fda5ee770637/Chozita-1.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "02ed52a107d5f7e9fe445318467d2b48c80eb1753175601e37824944547945eb",
"md5": "e805db4378969b1cf5e56456c87d21f7",
"sha256": "2cea1593c3b63189940a9024c00255770b01d5c5a3cd79d78472ced88f32ee16"
},
"downloads": -1,
"filename": "chozita-1.5.5.tar.gz",
"has_sig": false,
"md5_digest": "e805db4378969b1cf5e56456c87d21f7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4836,
"upload_time": "2024-07-08T00:51:12",
"upload_time_iso_8601": "2024-07-08T00:51:12.909225Z",
"url": "https://files.pythonhosted.org/packages/02/ed/52a107d5f7e9fe445318467d2b48c80eb1753175601e37824944547945eb/chozita-1.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 00:51:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "BAA4TS",
"github_project": "Chozita",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "chozita"
}
JSON
