mjhaycuribs

🐍 pinq - Effortless Python Prompts for Users

📦 Overview

pinq is a Python binding for the Rust inquire CLI prompt library. This tool lets you build easy-to-use command line prompts for text, passwords, selections, and more. Whether you’re gathering user input or creating forms, pinq simplifies the process.

🚀 Getting Started

Follow these steps to get started with pinq quickly. This guide assumes no prior programming knowledge.

1. 🌐 System Requirements

Operating System: Windows, macOS, or Linux
Python Version: 3.6 or later
Rust: Installed to build bindings (optional, for advanced users)

2. 📥 Download & Install

To get pinq, visit this page to download the latest release:

Download pinq

3. 📂 Download Options

On the Releases page, you will see different versions of pinq. Each version has files formatted for your operating system.

For Windows, download the file ending with .exe.
For macOS, choose the .dmg file.
For Linux, select the file with .tar.gz.

4. 📂 Install pinq

Once you’ve downloaded your version, follow these simple steps:

For Windows:

Locate the downloaded .exe file in your Downloads folder.
Double-click the file to run it.
Follow the installation prompts.

For macOS:

Double-click the downloaded .dmg file.
Drag the pinq icon to your Applications folder.
Open the Applications folder and double-click the pinq icon.

For Linux:

Open a terminal window.
Navigate to your Downloads folder using cd ~/Downloads.
Extract the package using tar -xvzf yourfile.tar.gz.
Follow the instructions in the extracted folder to set it up.

🎉 Using pinq

Once installed, you can use pinq in your terminal or command prompt. Open your terminal and start typing.

1. 📝 Creating a Text Prompt

You can create a simple text prompt like this:

from pinq import prompt

response = prompt("What is your name?")
print(f"Hello, {response}!")

2. 🔐 Creating a Password Prompt

To ask for a password, use:

from pinq import prompt

password = prompt("Enter your password:", password=True)
print("Your password has been saved.")

For making choices, you can use a select prompt:

from pinq import prompt

favorite_color = prompt("Choose your favorite color:", choices=["Red", "Blue", "Green"])
print(f"You selected {favorite_color}.")

💻 Features

Text Prompts: Gather input from users easily.
Password Prompts: Securely capture passwords.
Select & MultiSelect: Let users choose one or more options.
Date Picker: Simplify date input.
Editor Prompt: Allow users to edit text easily.

🔍 Troubleshooting

If you encounter any issues, consider the following solutions:

Installation Errors: Ensure you have the correct Python version.
Prompt Not Showing: Verify that your terminal supports interactive inputs.
File Not Found: Double-check your download location and filenames.

📢 Community & Support

If you need help or want to share tips, you can interact with the community. Join our discussion on GitHub or check out the Issues section for common problems and solutions.

🌟 Contribution

We welcome contributions! If you enjoy using pinq and want to help improve it:

Fork the repository.
Make your changes.
Submit a pull request.

Your input helps us make pinq better!

🚀 Final Steps

Now that you know how to use pinq, get started by visiting this page to download: