Onepassword Utils

A collection of utility functions for interacting with 1Password via the command-line interface (CLI).

Features

• Retrieve credentials (username and password) from 1Password vaults securely within your Python scripts.
• Simplifies the process of automating tasks and managing sensitive information.

Prerequisites

• 1Password: You need to have 1Password installed and set up on your system.
• 1Password CLI (op): Install the 1Password CLI by following the instructions on the 1Password Developer website.

Installation

pip install onepassword_utils

Usage

import onepassword_utils

# Retrieve credentials from a 1Password item
item_uuid = "your_item_uuid"  # Replace with the actual UUID of your 1Password item
username, password = onepassword_utils.get_credentials_from_1password(item_uuid)

if username and password:
    print(f"Username: {username}")
    print(f"Password: {password}")
    # ... Use the credentials in your script
else:
    print("Failed to retrieve credentials.")

Important:

Make sure you have the 1Password CLI (op) installed and configured correctly before using this package. Handle the retrieved credentials securely within your scripts. Avoid printing them to the console or storing them in plain text.

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues if you find any bugs or have suggestions for improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.  

Key points:

• Clear sections: The README is organized into clear sections with headings to make it easy to navigate.
• Prerequisites: The prerequisites section explicitly mentions the need for 1Password and the 1Password CLI.
• Installation: Provides the pip install command for easy installation.
• Usage: Includes a concise code example demonstrating how to use the get_credentials_from_1password function.
• Important notes: Highlights important considerations for security and setup.
• Contributing and License: Encourages contributions and specifies the license under which the project is released.

Remember to replace placeholders like your_item_uuid and your-username with your actual values.

You can further enhance the README by adding more detailed explanations, additional usage examples, or information about any other functions you might include in your onepassword_utils package in the future.

Let me know if you have any other questions or need help with further refinements!