paramsx 1.0.7__tar.gz → 1.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2 @@
1
+ include paramsx/paramsx_config.py
2
+ include paramsx/post_install.py
@@ -1,9 +1,10 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: paramsx
3
- Version: 1.0.7
3
+ Version: 1.1.0
4
4
  Summary: Librería para gestionar y respaldar parámetros de AWS SSM de manera sencilla y eficiente.
5
5
  Home-page: https://github.com/pistatxos/paramsx
6
6
  Author: Mariox
7
7
  Author-email: info@tomonota.net
8
8
  License-File: LICENSE
9
9
  Requires-Dist: boto3
10
+ Requires-Dist: windows-curses; platform_system == "Windows"
@@ -8,17 +8,25 @@ ParamsX es una librería diseñada para gestionar parámetros de AWS SSM de mane
8
8
 
9
9
 
10
10
  #### Consejos varios para tener un orden en los parámetros
11
- Para un uso óptimo, se recomienda organizar los parámetros de AWS SSM utilizando prefijos que sigan una estructura lógica. Por ejemplo:
11
+ Para aprovechar al máximo ParamsX, te recomendamos estructurar los parámetros de AWS SSM siguiendo un esquema lógico y ordenado. Por ejemplo:
12
12
  - /APP/nombreApp/tipoEntorno/más datos...
13
13
 
14
- Esta estructura permite identificar y gestionar los parámetros por su aplicación y entorno. En ParamsX, puedes configurar listas específicas para modificar y gestionar estos parámetros de manera eficiente.
14
+ Ventajas de usar esta estructura:
15
+ - Claridad: Es más sencillo identificar a qué aplicación, entorno o componente pertenece cada parámetro.
16
+ - Escalabilidad: Facilita el crecimiento de tu infraestructura manteniendo un orden consistente.
17
+ - Gestión simplificada: Con ParamsX, puedes configurar listas específicas de parámetros basadas en estos prefijos, lo que permite modificarlos o gestionarlos de forma eficiente.
18
+
19
+ Este enfoque te permitirá integrar ParamsX de manera más efectiva en tu flujo de trabajo y mantener el control de tus parámetros en AWS SSM.
15
20
 
16
21
  ## Instalación
17
22
 
18
- pip install paramx
23
+ ```pip install paramx```
19
24
 
20
25
  ### Configuración inicial
21
- Al instalar el paquete, se crea automáticamente una carpeta de configuración en tu directorio de usuario:
26
+ Una vez instalado el paquete, debes configurar ParamsX antes de usarlo. Para ello, ejecuta el siguiente comando:
27
+ ``` paramsx configure ```
28
+
29
+ Este comando creará automáticamente una carpeta de configuración en tu directorio de usuario:
22
30
 
23
31
  Windows: C:\Users\<tu_usuario>\.xsoft
24
32
  Linux/MacOS: /home/<tu_usuario>/.xsoft
@@ -31,9 +39,9 @@ Contenido de paramsx_config.py:
31
39
  ```
32
40
  configuraciones = {
33
41
  "profile_name": "default", # Cambiar por el nombre de tu perfil en ~/.aws/credentials
34
- "region_name": "us-east-1", # Cambiar por tu región de AWS
42
+ "region_name": "eu-south-2", # Cambiar por tu región de AWS
35
43
  "entornos": ["DEV", "PROD"], # Los entornos que manejarás
36
- "parameter_list": [
44
+ "parameter_list": [ # Cambiar por lista de parámetros.
37
45
  "/params1/xx",
38
46
  "/params2/xx",
39
47
  ]
@@ -63,6 +71,15 @@ El programa mostrará un menú donde Podrás:
63
71
  - parameters_DEV_backup.py
64
72
  ```Importante: Los archivos se generarán en la misma ruta desde donde ejecutes el comando paramsx```
65
73
 
74
+ ### Modificar parámetros actuales
75
+ Un pequeño truco para modificar tus parámetros actuales:
76
+ 1. Crea los archivos necesarios:
77
+ - parameters_DEV.py (Cambia DEV por el entorno deseado)
78
+ - parameters_DEV_backup.py (Cambia DEV por el entorno deseado)
79
+ 2. Copia tus parámetros dentro de cada uno de ellos.
80
+ 3. Modifica los en el archivo parameters_DEV.py
81
+ 4. Accede a paramsx y usa la opción 2 de cargar seleccionando el entorno.
82
+ 5. Verás tus parametros nuevos, modificados y los que se eliminarán.
66
83
 
67
84
  ### Cargar Parámetros:
68
85
  1. Modifica los archivos generados (parameters_DEV.py).
@@ -74,6 +91,19 @@ El programa mostrará un menú donde Podrás:
74
91
  * Revisa los cambios antes de confirmar.
75
92
  ```Importante: Una vez confirmados los cambios, los archivos parameters_DEV.py y parameters_DEV_backup.py se eliminarán automáticamente```
76
93
 
94
+ ### Backup Parámetros:
95
+ 1. Backup de un rango específico:
96
+ Selecciona un prefijo y un entorno específico.
97
+ Se creará un archivo único con el respaldo de los parámetros de esa selección.
98
+ Ideal para respaldar y modificar parámetros de una aplicación o entorno en particular.
99
+ 2. Backup de todos los parámetros listados:
100
+ Genera un respaldo combinado de todos los prefijos definidos en tu configuración (parameter_list) y sus entornos asociados.
101
+ Se crea un archivo total_listed_parameters_backup.py que contiene los parámetros organizados.
102
+ 3. Backup de todos los parámetros de la cuenta de AWS:
103
+ Lee todos los parámetros de AWS SSM desde la raíz (/).
104
+ Se crea un archivo all_parameters_backup.py con el respaldo completo de la cuenta.
105
+ Ten en cuenta que este proceso puede tardar dependiendo de la cantidad de parámetros almacenados.
106
+
77
107
  ### Notas Adicionales
78
108
  - Credenciales de AWS:
79
109
  Asegúrate de que el perfil especificado en paramsx_config.py exista en tus archivos de configuración de AWS (~/.aws/credentials y ~/.aws/config).
@@ -1,4 +1,5 @@
1
1
  import os
2
+ import sys
2
3
  import boto3
3
4
  import curses
4
5
  import importlib.util
@@ -164,43 +165,153 @@ def main(stdscr):
164
165
 
165
166
  elif choice == '3':
166
167
  # Crear backup
168
+ PARAMETER_LIST.append("Total parámetros listados.") # Agregar opción para backup total listado
169
+ PARAMETER_LIST.append("Total parámetros de la cuenta.") # Añadir opción para backup total de la cuenta
170
+
167
171
  param_choice = show_parameter_selection(stdscr, PARAMETER_LIST)
168
172
  if param_choice is None: # Si se presionó Esc
173
+ PARAMETER_LIST.pop() # Eliminar opciones extra
174
+ PARAMETER_LIST.pop()
169
175
  continue # Regresar al menú principal
170
176
 
171
177
  selected_param = PARAMETER_LIST[param_choice]
172
178
 
173
- env_choice = show_environment_selection(stdscr, environments)
174
- if env_choice is None: # Si se presionó Esc
175
- continue # Regresar al menú principal
176
-
177
- selected_env = environments[env_choice]
179
+ if selected_param == "Total parámetros listados.":
180
+ # Crear backup de todos los parámetros listados
181
+ all_parameters = []
182
+ for param in PARAMETER_LIST[:-2]: # Excluir las opciones adicionales
183
+ for env in environments:
184
+ full_path = f"{param}/{env}"
185
+ try:
186
+ # Obtener parámetros desde AWS SSM
187
+ parameters = get_parameters_by_prefix(ssm, full_path)
188
+ all_parameters.extend(parameters)
189
+ except ValueError as e:
190
+ show_message(stdscr, f"ERROR en {param}/{env}: {e}", 2)
191
+ except Exception as e:
192
+ show_message(stdscr, f"Error inesperado en {param}/{env}: {e}", 2)
193
+
194
+ # Crear archivo de backup total listado
195
+ backup_file_name = "total_listed_parameters_backup.py"
196
+ export_parameters_to_file(all_parameters, backup_file_name)
197
+
198
+ # Confirmación de backup creado
199
+ show_message(stdscr, f"Backup total listado creado:\n- {backup_file_name}", 3)
200
+
201
+ elif selected_param == "Total parámetros de la cuenta.":
202
+ try:
203
+ # Obtener todos los parámetros desde AWS SSM
204
+ parameters = get_parameters_by_prefix(ssm, "/") # Leer desde la raíz
205
+ except Exception as e:
206
+ show_message(stdscr, f"Error inesperado al leer parámetros: {e}", 2)
207
+ PARAMETER_LIST.pop() # Eliminar opciones extra
208
+ PARAMETER_LIST.pop()
209
+ continue # Regresar al menú principal
210
+
211
+ # Crear archivo de backup de todos los parámetros
212
+ backup_file_name = "all_parameters_backup.py"
213
+ export_parameters_to_file(parameters, backup_file_name)
214
+ show_message(stdscr, f"Backup de todos los parámetros creado:\n- {backup_file_name}", 3)
178
215
 
179
- # Crear el prefijo completo
180
- full_path = f"{selected_param}/{selected_env}"
181
- try:
182
- # Obtener parámetros desde AWS SSM
183
- parameters = get_parameters_by_prefix(ssm, full_path)
184
- except ValueError as e:
185
- show_message(stdscr, f"ERROR: {e}", 2)
186
- continue # Regresar al menú principal
187
- except Exception as e:
188
- show_message(stdscr, f"Error inesperado: {e}", 2)
189
- continue # Regresar al menú principal
190
-
191
- # Crear archivo de backup con nombre claro
192
- backup_file_name = f"{selected_param.replace('/', '_')}_{selected_env}_backup.py"
193
- export_parameters_to_file(parameters, backup_file_name)
194
-
195
- # Confirmación de backup creado
196
- show_message(stdscr, f"Backup creado:\n- {backup_file_name}", 3)
216
+ else:
217
+ # Backup normal para un prefijo específico
218
+ env_choice = show_environment_selection(stdscr, environments)
219
+ if env_choice is None: # Si se presionó Esc
220
+ PARAMETER_LIST.pop() # Eliminar opciones extra
221
+ PARAMETER_LIST.pop()
222
+ continue # Regresar al menú principal
223
+
224
+ selected_env = environments[env_choice]
225
+
226
+ # Crear el prefijo completo
227
+ full_path = f"{selected_param}/{selected_env}"
228
+ try:
229
+ # Obtener parámetros desde AWS SSM
230
+ parameters = get_parameters_by_prefix(ssm, full_path)
231
+ except ValueError as e:
232
+ show_message(stdscr, f"ERROR: {e}", 2)
233
+ PARAMETER_LIST.pop() # Eliminar opciones extra
234
+ PARAMETER_LIST.pop()
235
+ continue # Regresar al menú principal
236
+ except Exception as e:
237
+ show_message(stdscr, f"Error inesperado: {e}", 2)
238
+ PARAMETER_LIST.pop() # Eliminar opciones extra
239
+ PARAMETER_LIST.pop()
240
+ continue # Regresar al menú principal
241
+
242
+ # Crear archivo de backup con nombre claro
243
+ backup_file_name = f"{selected_param.replace('/', '_')}_{selected_env}_backup.py"
244
+ export_parameters_to_file(parameters, backup_file_name)
245
+
246
+ # Confirmación de backup creado
247
+ show_message(stdscr, f"Backup creado:\n- {backup_file_name}", 3)
248
+
249
+ # Limpiar las opciones adicionales
250
+ PARAMETER_LIST.pop()
251
+ PARAMETER_LIST.pop()
197
252
 
198
253
 
199
254
  else:
200
255
  show_message(stdscr, "Opción inválida. Inténtalo de nuevo.", 2)
201
256
 
257
+
258
+ # Función para crear la configuración inicial
259
+ def create_config():
260
+ config_dir = os.path.expanduser("~/.xsoft")
261
+ os.makedirs(config_dir, exist_ok=True)
262
+
263
+ config_file = os.path.join(config_dir, "paramsx_config.py")
264
+ if os.path.exists(config_file):
265
+ print(f"El archivo de configuración ya existe en {config_file}. No se sobrescribirá.")
266
+ else:
267
+ with open(config_file, "w") as f:
268
+ f.write("""configuraciones = {
269
+ "profile_name": "default", # Cambia por tu perfil de AWS si tienes otros
270
+ "region_name": "eu-south-2", # Cambia por tu región de AWS que necesites
271
+ "entornos": ["DEV", "PROD"], # Lista de los entornos
272
+ "parameter_list": [ # Cambia por tu lista de parámetros
273
+ "/params1/xx",
274
+ "/params2/xx"
275
+ ]
276
+ }""")
277
+ print(f"Archivo de configuración creado en {config_file}. Por favor, edítalo con tus valores personalizados.")
278
+
279
+ # Mostrar ayuda
280
+ def show_help():
281
+ help_text = """
282
+ ParamsX - Gestión de Parámetros de AWS SSM
283
+
284
+ Comandos disponibles:
285
+ paramsx Ejecuta el programa principal (requiere configuración previa).
286
+ paramsx configure Crea el archivo de configuración inicial en ~/.xsoft/paramsx_config.py.
287
+ paramsx --help Muestra esta ayuda.
288
+
289
+ """
290
+ print(help_text)
291
+
292
+ # Entry point
202
293
  def entry_point():
294
+ if len(sys.argv) > 1:
295
+ command = sys.argv[1]
296
+ if command in ["configure", "config", "configurar"]:
297
+ create_config()
298
+ return
299
+ elif command in ["--help", "-h"]:
300
+ show_help()
301
+ return
302
+
303
+ # Verificar que exista el archivo de configuración
304
+ config_file = os.path.expanduser("~/.xsoft/paramsx_config.py")
305
+ if not os.path.exists(config_file):
306
+ print("Error: No se encontró el archivo de configuración.")
307
+ print("Usa 'paramsx configure' para crear uno automáticamente.")
308
+ return
309
+
310
+ # Ejecutar el programa principal
311
+ import curses
312
+ from .main import main
203
313
  curses.wrapper(main)
204
314
 
315
+
205
316
  if __name__ == "__main__":
206
317
  curses.wrapper(main)
@@ -1,9 +1,10 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: paramsx
3
- Version: 1.0.7
3
+ Version: 1.1.0
4
4
  Summary: Librería para gestionar y respaldar parámetros de AWS SSM de manera sencilla y eficiente.
5
5
  Home-page: https://github.com/pistatxos/paramsx
6
6
  Author: Mariox
7
7
  Author-email: info@tomonota.net
8
8
  License-File: LICENSE
9
9
  Requires-Dist: boto3
10
+ Requires-Dist: windows-curses; platform_system == "Windows"
@@ -0,0 +1,4 @@
1
+ boto3
2
+
3
+ [:platform_system == "Windows"]
4
+ windows-curses
@@ -13,15 +13,12 @@ class CustomInstallCommand(install):
13
13
  # 1. Agregar directorio de scripts al PATH
14
14
  self._add_scripts_to_path()
15
15
 
16
- # 2. Crear carpeta de configuración .xsoft
17
- self._create_config_folder()
18
-
19
16
  def _add_scripts_to_path(self):
17
+ """Añadir directorio de scripts al PATH del sistema."""
20
18
  system = platform.system()
21
19
  scripts_dir = None
22
20
 
23
21
  if system == "Windows":
24
- # Ruta del directorio de scripts en Windows
25
22
  scripts_dir = os.path.join(
26
23
  os.path.expanduser("~"),
27
24
  "AppData",
@@ -39,55 +36,42 @@ class CustomInstallCommand(install):
39
36
  if system == "Windows":
40
37
  os.system(f'setx PATH "{path_env};{scripts_dir}"')
41
38
  print(f"Se agregó {scripts_dir} al PATH. Reinicia tu terminal para que los cambios surtan efecto.")
42
- elif system == "Darwin":
43
- self._add_to_shell_config("~/.zshrc", scripts_dir)
44
- elif system == "Linux":
45
- self._add_to_shell_config("~/.bashrc", scripts_dir)
46
-
47
- def _create_config_folder(self):
48
- config_dir = os.path.expanduser("~/.xsoft")
49
- os.makedirs(config_dir, exist_ok=True)
50
-
51
- config_file = "paramsx/paramsx_config.py"
52
- target_file = os.path.join(config_dir, "paramsx_config.py")
53
-
54
- if os.path.exists(target_file):
55
- print(f"El archivo de configuración ya existe en {target_file}. No se sobrescribirá.")
56
- else:
57
- if os.path.exists(config_file):
58
- shutil.copy(config_file, target_file)
59
- print(f"Archivo de configuración copiado a {target_file}")
60
- else:
61
- print(f"Advertencia: No se encontró {config_file}. No se creó la configuración inicial.")
39
+ elif system in ["Darwin", "Linux"]:
40
+ shell_config = "~/.zshrc" if system == "Darwin" else "~/.bashrc"
41
+ self._add_to_shell_config(shell_config, scripts_dir)
62
42
 
63
43
 
64
- def _add_to_shell_config(self, config_file, scripts_dir):
65
- """Añadir el directorio de scripts al archivo de configuración de shell."""
44
+ def _add_to_shell_config(self, shell_config, scripts_dir):
45
+ """Añadir el directorio de scripts al archivo de configuración del shell."""
46
+ shell_config = os.path.expanduser(shell_config)
66
47
  export_line = f'export PATH="{scripts_dir}:$PATH"'
67
- if os.path.exists(config_file):
68
- with open(config_file, "a") as f:
69
- f.write(f"\n{export_line}\n")
70
- print(f"Se agregó {scripts_dir} a {config_file}.")
71
- else:
72
- with open(config_file, "w") as f:
73
- f.write(f"{export_line}\n")
74
- print(f"Se creó {config_file} y se agregó {scripts_dir}.")
75
48
 
76
- install_requires = ["boto3"]
49
+ try:
50
+ if os.path.exists(shell_config):
51
+ with open(shell_config, "a") as f:
52
+ f.write(f"\n{export_line}\n")
53
+ print(f"Se agregó {scripts_dir} a {shell_config}.")
54
+ else:
55
+ with open(shell_config, "w") as f:
56
+ f.write(f"{export_line}\n")
57
+ print(f"Se creó {shell_config} y se agregó {scripts_dir}.")
58
+ except Exception as e:
59
+ print(f"Error al actualizar el archivo de shell {shell_config}: {e}")
77
60
 
78
- # Añadir windows-curses si el sistema es Windows
79
- if platform.system() == "Windows":
80
- install_requires.append("windows-curses")
81
61
 
62
+ # Configuración del paquete
82
63
  setup(
83
64
  name="paramsx",
84
- version="1.0.7",
65
+ version="1.1.0",
85
66
  packages=find_packages(),
86
67
  include_package_data=True,
87
68
  package_data={
88
- 'paramsx': ['paramsx_config.py'], # Archivos específicos
69
+ "paramsx": ["paramsx_config.py"], # Asegúrate de incluir este archivo
89
70
  },
90
- install_requires=install_requires,
71
+ install_requires= [
72
+ "boto3",
73
+ "windows-curses; platform_system == 'Windows'",
74
+ ],
91
75
  entry_points={
92
76
  "console_scripts": [
93
77
  "paramsx=paramsx.main:entry_point",
paramsx-1.0.7/MANIFEST.in DELETED
@@ -1 +0,0 @@
1
- include paramsx/paramsx_config.py
@@ -1 +0,0 @@
1
- boto3
File without changes
File without changes
File without changes
File without changes
File without changes