keylocker 0.4.2__tar.gz → 0.4.3__tar.gz

keylocker-0.4.3/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.3
+Name: keylocker
+Version: 0.4.3
+Summary: Library with the CLI to save the encrypted secrets in the configuration file, but a transparent read and write the new settings in the app.
+License: MIT
+Author: vpuhoff
+Author-email: vpuhoff@live.ru
+Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Description-Content-Type: text/markdown
+
+# Keylocker CLI (YAML Edition)
+
+A command-line interface (CLI) tool and Python library for managing secrets directly within YAML configuration files. Allows encrypting individual values using the `!SEC` tag and loading values from environment variables using the `!ENV` tag.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install keylocker
+```
+
+The package is available on PyPI: [https://pypi.org/project/keylocker/](https://pypi.org/project/keylocker/)
+
+## Example YAML file (`config.yaml`):
+
+```yaml
+# config.yaml
+database:
+  host: db.example.com
+  username: user
+  # Encrypted password using 'keylocker encrypt'
+  password: !SEC gAAAAABh...[rest of encrypted data]...
+api:
+  endpoint: [https://api.example.com](https://api.example.com)
+  # Load key from the API_KEY environment variable
+  key: !ENV API_KEY
+deployment:
+  region: us-east-1
+  # Another secret
+  ssh_key_pass: !SEC gAAAAABh...[another encrypted data]...
+```
+
+## CLI Usage:
+
+1.  **Initialization (create key):**
+    ```bash
+    keylocker init
+    # The storage.key file will be created (if it doesn't exist)
+    ```
+
+2.  **Encrypt value for YAML insertion:**
+    ```bash
+    keylocker encrypt "my_secret_value"
+    # Output:
+    # Add the following line to your YAML file:
+    # !SEC gAAAAABh...[encrypted data]...
+
+    # Copy the !SEC ... line into your YAML file
+    ```
+
+3.  **View decrypted YAML:**
+    ```bash
+    # Set the environment variable (if using !ENV)
+    export API_KEY="your_actual_api_key"
+
+    keylocker view config.yaml
+    # Outputs the YAML with !SEC values decrypted
+    # and !ENV values substituted
+    # Example output:
+    # database:
+    #   host: db.example.com
+    #   username: user
+    #   password: my_secret_value # Decrypted!
+    # api:
+    #   endpoint: [https://api.example.com](https://api.example.com)
+    #   key: your_actual_api_key  # Substituted from env!
+    # deployment:
+    #   region: us-east-1
+    #   ssh_key_pass: decrypted_pass # Decrypted!
+    ```
+    *(Note: An `edit` command might be added in the future for interactive editing)*
+
+## Usage in Python Code:
+
+```python
+import os
+from keylocker import load_yaml_secrets
+
+# Set environment variables if needed
+os.environ['API_KEY'] = 'your_actual_api_key_for_python'
+
+config_file = 'config.yaml'
+key_file = 'storage.key' # Make sure the key exists
+
+try:
+    # Load and automatically decrypt/substitute
+    secrets = load_yaml_secrets(config_file, key_file)
+
+    if secrets:
+        db_password = secrets.get('database', {}).get('password')
+        api_key = secrets.get('api', {}).get('key')
+
+        print(f"Database Password: {db_password}")
+        print(f"API Key: {api_key}")
+
+except Exception as e:
+    print(f"An error occurred: {e}")
+```
+
+## Usage in Bash:
+
+To extract specific values from the decrypted YAML, you can use utilities like `yq` or standard Unix tools.
+
+```bash
+#!/bin/bash
+
+# Make sure the environment variable is set if needed
+export API_KEY="your_bash_api_key"
+
+# Get the decrypted YAML
+CONFIG_YAML=$(keylocker view config.yaml)
+
+# Check if the command executed successfully
+if [ $? -ne 0 ]; then
+  echo "Error executing keylocker view"
+  exit 1
+fi
+
+# Example extraction using yq (requires yq installation)
+# DB_PASS=$(echo "$CONFIG_YAML" | yq e '.database.password' -)
+# API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | yq e '.api.key' -)
+
+# Example extraction using grep/awk (less robust)
+DB_PASS=$(echo "$CONFIG_YAML" | grep -A 1 'database:' | grep 'password:' | awk '{print $2}')
+API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | grep -A 1 'api:' | grep 'key:' | awk '{print $2}')
+
+
+echo "Extracted DB Password: $DB_PASS"
+echo "Extracted API Key: $API_KEY_FROM_YAML"
+
+# Further use of variables...
+# e.g., publish command using extracted credentials
+# some_command --username user --password "${DB_PASS}"
+```
+
+## Source Code:
+* [https://github.com/vpuhoff/keylocker](https://github.com/vpuhoff/keylocker)
+

keylocker-0.4.3/README.md

@@ -0,0 +1,138 @@
+# Keylocker CLI (YAML Edition)
+
+A command-line interface (CLI) tool and Python library for managing secrets directly within YAML configuration files. Allows encrypting individual values using the `!SEC` tag and loading values from environment variables using the `!ENV` tag.
+
+## Installation
+
+You can install the package using pip:
+
+```bash
+pip install keylocker
+```
+
+The package is available on PyPI: [https://pypi.org/project/keylocker/](https://pypi.org/project/keylocker/)
+
+## Example YAML file (`config.yaml`):
+
+```yaml
+# config.yaml
+database:
+  host: db.example.com
+  username: user
+  # Encrypted password using 'keylocker encrypt'
+  password: !SEC gAAAAABh...[rest of encrypted data]...
+api:
+  endpoint: [https://api.example.com](https://api.example.com)
+  # Load key from the API_KEY environment variable
+  key: !ENV API_KEY
+deployment:
+  region: us-east-1
+  # Another secret
+  ssh_key_pass: !SEC gAAAAABh...[another encrypted data]...
+```
+
+## CLI Usage:
+
+1.  **Initialization (create key):**
+    ```bash
+    keylocker init
+    # The storage.key file will be created (if it doesn't exist)
+    ```
+
+2.  **Encrypt value for YAML insertion:**
+    ```bash
+    keylocker encrypt "my_secret_value"
+    # Output:
+    # Add the following line to your YAML file:
+    # !SEC gAAAAABh...[encrypted data]...
+
+    # Copy the !SEC ... line into your YAML file
+    ```
+
+3.  **View decrypted YAML:**
+    ```bash
+    # Set the environment variable (if using !ENV)
+    export API_KEY="your_actual_api_key"
+
+    keylocker view config.yaml
+    # Outputs the YAML with !SEC values decrypted
+    # and !ENV values substituted
+    # Example output:
+    # database:
+    #   host: db.example.com
+    #   username: user
+    #   password: my_secret_value # Decrypted!
+    # api:
+    #   endpoint: [https://api.example.com](https://api.example.com)
+    #   key: your_actual_api_key  # Substituted from env!
+    # deployment:
+    #   region: us-east-1
+    #   ssh_key_pass: decrypted_pass # Decrypted!
+    ```
+    *(Note: An `edit` command might be added in the future for interactive editing)*
+
+## Usage in Python Code:
+
+```python
+import os
+from keylocker import load_yaml_secrets
+
+# Set environment variables if needed
+os.environ['API_KEY'] = 'your_actual_api_key_for_python'
+
+config_file = 'config.yaml'
+key_file = 'storage.key' # Make sure the key exists
+
+try:
+    # Load and automatically decrypt/substitute
+    secrets = load_yaml_secrets(config_file, key_file)
+
+    if secrets:
+        db_password = secrets.get('database', {}).get('password')
+        api_key = secrets.get('api', {}).get('key')
+
+        print(f"Database Password: {db_password}")
+        print(f"API Key: {api_key}")
+
+except Exception as e:
+    print(f"An error occurred: {e}")
+```
+
+## Usage in Bash:
+
+To extract specific values from the decrypted YAML, you can use utilities like `yq` or standard Unix tools.
+
+```bash
+#!/bin/bash
+
+# Make sure the environment variable is set if needed
+export API_KEY="your_bash_api_key"
+
+# Get the decrypted YAML
+CONFIG_YAML=$(keylocker view config.yaml)
+
+# Check if the command executed successfully
+if [ $? -ne 0 ]; then
+  echo "Error executing keylocker view"
+  exit 1
+fi
+
+# Example extraction using yq (requires yq installation)
+# DB_PASS=$(echo "$CONFIG_YAML" | yq e '.database.password' -)
+# API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | yq e '.api.key' -)
+
+# Example extraction using grep/awk (less robust)
+DB_PASS=$(echo "$CONFIG_YAML" | grep -A 1 'database:' | grep 'password:' | awk '{print $2}')
+API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | grep -A 1 'api:' | grep 'key:' | awk '{print $2}')
+
+
+echo "Extracted DB Password: $DB_PASS"
+echo "Extracted API Key: $API_KEY_FROM_YAML"
+
+# Further use of variables...
+# e.g., publish command using extracted credentials
+# some_command --username user --password "${DB_PASS}"
+```
+
+## Source Code:
+* [https://github.com/vpuhoff/keylocker](https://github.com/vpuhoff/keylocker)

{keylocker-0.4.2 → keylocker-0.4.3}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "keylocker"
-version = "0.4.2" # Убедитесь, что версия актуальна
-description = "Инструмент CLI и библиотека для управления секретами в YAML файлах с шифрованием." # Описание обновлено
+version = "0.4.3" # Убедитесь, что версия актуальна
+description = "Library with the CLI to save the encrypted secrets in the configuration file, but a transparent read and write the new settings in the app."
 readme = "README.md"
 license = { text = "MIT" } 
 authors = [

keylocker-0.4.2/PKG-INFO

@@ -1,154 +0,0 @@
-Metadata-Version: 2.3
-Name: keylocker
-Version: 0.4.2
-Summary: Инструмент CLI и библиотека для управления секретами в YAML файлах с шифрованием.
-License: MIT
-Author: vpuhoff
-Author-email: vpuhoff@live.ru
-Requires-Python: >=3.10
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Utilities
-Description-Content-Type: text/markdown
-
-# Keylocker CLI (YAML Edition)
-
-Инструмент командной строки (CLI) и библиотека Python для управления секретами непосредственно в YAML файлах конфигурации. Позволяет шифровать отдельные значения с помощью тега `!SEC` и загружать значения из переменных окружения с помощью тега `!ENV`.
-
-## Пример YAML файла (`config.yaml`):
-
-```yaml
-# config.yaml
-database:
-  host: db.example.com
-  username: user
-  # Зашифрованный пароль с помощью keylocker encrypt
-  password: !SEC gAAAAABh...[rest of encrypted data]...
-api:
-  endpoint: [https://api.example.com](https://api.example.com)
-  # Загрузка ключа из переменной окружения API_KEY
-  key: !ENV API_KEY
-deployment:
-  region: us-east-1
-  # Еще один секрет
-  ssh_key_pass: !SEC gAAAAABh...[another encrypted data]...
-````
-
-## Использование в CLI:
-
-1.  **Инициализация (создание ключа):**
-
-    ```bash
-    keylocker init
-    # Будет создан файл storage.key (если не существует)
-    ```
-
-2.  **Шифрование значения для вставки в YAML:**
-
-    ```bash
-    keylocker encrypt "my_secret_value"
-    # Вывод:
-    # Add the following line to your YAML file:
-    # !SEC gAAAAABh...[encrypted data]...
-
-    # Скопируйте строку !SEC ... в ваш YAML файл
-    ```
-
-3.  **Просмотр расшифрованного YAML:**
-
-    ```bash
-    # Установите переменную окружения (если используется !ENV)
-    export API_KEY="your_actual_api_key"
-
-    keylocker view config.yaml
-    # Выведет YAML с расшифрованными значениями !SEC
-    # и подставленными значениями !ENV
-    # Пример вывода:
-    # database:
-    #   host: db.example.com
-    #   username: user
-    #   password: my_secret_value # Расшифровано!
-    # api:
-    #   endpoint: [https://api.example.com](https://api.example.com)
-    #   key: your_actual_api_key  # Подставлено из env!
-    # deployment:
-    #   region: us-east-1
-    #   ssh_key_pass: decrypted_pass # Расшифровано!
-    ```
-
-    *(Примечание: Команда `edit` может быть добавлена в будущем для интерактивного редактирования)*
-
-## Использование в коде Python:
-
-```python
-import os
-from keylocker import load_yaml_secrets
-
-# Установите переменные окружения, если нужно
-os.environ['API_KEY'] = 'your_actual_api_key_for_python'
-
-config_file = 'config.yaml'
-key_file = 'storage.key' # Убедитесь, что ключ существует
-
-try:
-    # Загрузка и автоматическая расшифровка/подстановка
-    secrets = load_yaml_secrets(config_file, key_file)
-
-    if secrets:
-        db_password = secrets.get('database', {}).get('password')
-        api_key = secrets.get('api', {}).get('key')
-
-        print(f"Database Password: {db_password}")
-        print(f"API Key: {api_key}")
-
-except Exception as e:
-    print(f"An error occurred: {e}")
-
-```
-
-## Использование в Bash:
-
-Для извлечения конкретных значений из расшифрованного YAML можно использовать утилиты вроде `yq` или стандартные инструменты Unix.
-
-```bash
-#!/bin/bash
-
-# Убедитесь, что переменная окружения установлена, если она нужна
-export API_KEY="your_bash_api_key"
-
-# Получаем расшифрованный YAML
-CONFIG_YAML=$(keylocker view config.yaml)
-
-# Проверка, что команда выполнилась успешно
-if [ $? -ne 0 ]; then
-  echo "Ошибка при выполнении keylocker view"
-  exit 1
-fi
-
-# Пример извлечения с помощью yq (требует установки yq)
-# DB_PASS=$(echo "$CONFIG_YAML" | yq e '.database.password' -)
-# API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | yq e '.api.key' -)
-
-# Пример извлечения с помощью grep/sed (менее надежно)
-DB_PASS=$(echo "$CONFIG_YAML" | grep -A 1 'database:' | grep 'password:' | awk '{print $2}')
-API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | grep -A 1 'api:' | grep 'key:' | awk '{print $2}')
-
-
-echo "Извлеченный пароль БД: $DB_PASS"
-echo "Извлеченный API ключ: $API_KEY_FROM_YAML"
-
-# Дальнейшее использование переменных...
-# poetry publish --username user --password "${DB_PASS}" --build
-```
-
-
-## Source Code:
-* [https://github.com/vpuhoff/keylocker](https://github.com/vpuhoff/keylocker)
-
-## Travis CI Deploys:
-* [https://travis-ci.com/vpuhoff/keylocker](https://travis-ci.com/vpuhoff/keylocker) [![Build Status](https://travis-ci.com/vpuhoff/keylocker.svg?branch=master)](https://travis-ci.com/vpuhoff/keylocker)
-

keylocker-0.4.2/README.md

@@ -1,136 +0,0 @@
-# Keylocker CLI (YAML Edition)
-
-Инструмент командной строки (CLI) и библиотека Python для управления секретами непосредственно в YAML файлах конфигурации. Позволяет шифровать отдельные значения с помощью тега `!SEC` и загружать значения из переменных окружения с помощью тега `!ENV`.
-
-## Пример YAML файла (`config.yaml`):
-
-```yaml
-# config.yaml
-database:
-  host: db.example.com
-  username: user
-  # Зашифрованный пароль с помощью keylocker encrypt
-  password: !SEC gAAAAABh...[rest of encrypted data]...
-api:
-  endpoint: [https://api.example.com](https://api.example.com)
-  # Загрузка ключа из переменной окружения API_KEY
-  key: !ENV API_KEY
-deployment:
-  region: us-east-1
-  # Еще один секрет
-  ssh_key_pass: !SEC gAAAAABh...[another encrypted data]...
-````
-
-## Использование в CLI:
-
-1.  **Инициализация (создание ключа):**
-
-    ```bash
-    keylocker init
-    # Будет создан файл storage.key (если не существует)
-    ```
-
-2.  **Шифрование значения для вставки в YAML:**
-
-    ```bash
-    keylocker encrypt "my_secret_value"
-    # Вывод:
-    # Add the following line to your YAML file:
-    # !SEC gAAAAABh...[encrypted data]...
-
-    # Скопируйте строку !SEC ... в ваш YAML файл
-    ```
-
-3.  **Просмотр расшифрованного YAML:**
-
-    ```bash
-    # Установите переменную окружения (если используется !ENV)
-    export API_KEY="your_actual_api_key"
-
-    keylocker view config.yaml
-    # Выведет YAML с расшифрованными значениями !SEC
-    # и подставленными значениями !ENV
-    # Пример вывода:
-    # database:
-    #   host: db.example.com
-    #   username: user
-    #   password: my_secret_value # Расшифровано!
-    # api:
-    #   endpoint: [https://api.example.com](https://api.example.com)
-    #   key: your_actual_api_key  # Подставлено из env!
-    # deployment:
-    #   region: us-east-1
-    #   ssh_key_pass: decrypted_pass # Расшифровано!
-    ```
-
-    *(Примечание: Команда `edit` может быть добавлена в будущем для интерактивного редактирования)*
-
-## Использование в коде Python:
-
-```python
-import os
-from keylocker import load_yaml_secrets
-
-# Установите переменные окружения, если нужно
-os.environ['API_KEY'] = 'your_actual_api_key_for_python'
-
-config_file = 'config.yaml'
-key_file = 'storage.key' # Убедитесь, что ключ существует
-
-try:
-    # Загрузка и автоматическая расшифровка/подстановка
-    secrets = load_yaml_secrets(config_file, key_file)
-
-    if secrets:
-        db_password = secrets.get('database', {}).get('password')
-        api_key = secrets.get('api', {}).get('key')
-
-        print(f"Database Password: {db_password}")
-        print(f"API Key: {api_key}")
-
-except Exception as e:
-    print(f"An error occurred: {e}")
-
-```
-
-## Использование в Bash:
-
-Для извлечения конкретных значений из расшифрованного YAML можно использовать утилиты вроде `yq` или стандартные инструменты Unix.
-
-```bash
-#!/bin/bash
-
-# Убедитесь, что переменная окружения установлена, если она нужна
-export API_KEY="your_bash_api_key"
-
-# Получаем расшифрованный YAML
-CONFIG_YAML=$(keylocker view config.yaml)
-
-# Проверка, что команда выполнилась успешно
-if [ $? -ne 0 ]; then
-  echo "Ошибка при выполнении keylocker view"
-  exit 1
-fi
-
-# Пример извлечения с помощью yq (требует установки yq)
-# DB_PASS=$(echo "$CONFIG_YAML" | yq e '.database.password' -)
-# API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | yq e '.api.key' -)
-
-# Пример извлечения с помощью grep/sed (менее надежно)
-DB_PASS=$(echo "$CONFIG_YAML" | grep -A 1 'database:' | grep 'password:' | awk '{print $2}')
-API_KEY_FROM_YAML=$(echo "$CONFIG_YAML" | grep -A 1 'api:' | grep 'key:' | awk '{print $2}')
-
-
-echo "Извлеченный пароль БД: $DB_PASS"
-echo "Извлеченный API ключ: $API_KEY_FROM_YAML"
-
-# Дальнейшее использование переменных...
-# poetry publish --username user --password "${DB_PASS}" --build
-```
-
-
-## Source Code:
-* [https://github.com/vpuhoff/keylocker](https://github.com/vpuhoff/keylocker)
-
-## Travis CI Deploys:
-* [https://travis-ci.com/vpuhoff/keylocker](https://travis-ci.com/vpuhoff/keylocker) [![Build Status](https://travis-ci.com/vpuhoff/keylocker.svg?branch=master)](https://travis-ci.com/vpuhoff/keylocker)