Introduction 🔗

Welcome to the Clipboardy documentation. This guide will help you navigate the features and functionality of Clipboardy, along with tutorials on installation and contributing via GitHub.

Getting Started 🔗

This step-by-step guide will help you get Clipboardy up and running.

Prerequisites

To install Clipboardy, you’ll need the following set up:

1. Python (newest version)
2. Required pip dependencies (listed below)
3. The latest version of Clipboardy from GitHub

Step 1: Installing Python

If you don’t have Python installed on your system, you can download it from the official Python website. Make sure to select "Add Python to PATH" during the installation process.

Step 2: Installing pip Dependencies

Clipboardy requires the following dependencies to work properly. You can install them all at once using the requirements.txt file, found on GitHub, or manually:

1. pyperclip – for clipboard management
2. cryptography – for encryption features
3. validators – to validate URLs
4. customtkinter – for a user-friendly interface

To install these dependencies using the requirements.txt file, wich you will need to download first, run this command:

pip install -r requirements.txt

Alternatively, you can install them manually by running:

pip install pyperclip cryptography validators customtkinter

Step 3: Downloading and Installing Clipboardy

Once you’ve installed Python and the necessary dependencies, head to the Clipboardy GitHub repository and go to the "Releases" section. Download the latest release of Clipboardy, unzip the files, and navigate to the src folder in your terminal.

To run Clipboardy, use this command, or just double click clipboardy.py:

python clipboardy.py

Download 🔗

This guide is about simply downloading the .exe file for personal use rather than contributing.

Prerequisites

You don’t need any other software for this .exe file to work. You only need to download the .exe from the latest release and unzip the .zip file to run the "clipboardy.exe" file.

Installation

Features 🔗

Saving Clipboards

Encryption/Decryption

All your saved clips (clipboard entries) will be encrypted for safety and automatically decrypted when showing them to you. View the "clips.json" file in the "package" folder to see all your clips in raw json as they are encrypted.

Auto Save

By toggeling the "Auto Save" switch in the buttom right corner, you can allow Clipboardy to read and compare each of your clips to save them automatically for you.

Functions

Next to the saved clip in the main window are two buttons, the first one being for coping the clip again and the second one to delete the clip. To delete all clips, press the "Delete All" button in the buttom section.

Searching and filtering

The searchbar allows you to search specific clips by thier name. The filter function is still in development and will be released soon.

Contributing 🔗

If you want to support the Clipboardy project and add your own ideas and improvements, please follow these guidelines:

Getting Started

To contribute to Clipboardy, first, fork the repository on GitHub and clone it to your local machine. You can do this by running:

git clone https://github.com/YOUR_USERNAME/clipboardy.git

Make sure to replace YOUR_USERNAME with your actual GitHub username.

Branching

Before making any new changes, create a new branch for your feature or bug fix. This keeps the master branch clean and allows for easier collaboration. Use the following command:

git checkout -b your-feature-name

Writing Code

When writing code, please adhere to the following conventions:

• Follow PEP 8: Make sure your Python code roughly similar to the PEP 8 style guide for Python code to maintain readability.
• Comment Your Code: Write clear comments explaining your logic, especially in complex sections, to avoid confusion for other developers.
• Function Documentation: Use docstrings to document your functions and classes, to explain their purpose.

Testing

Before submitting your changes, ensure that you have tested your code. This helps maintaining our projects stability.

Submitting Changes

Once you're satisfied with your changes, commit them with a clear and concise commit message:

git commit -m "Add a brief description of the changes"

Push your changes to your forked repository:

git push origin your-feature-name

Finally, create a pull request on the main repository. Describe the changes you made, why you made them, and any relevant details that can help us understand your contribution.

Standard Rules and Expectations

• Be Respectful: Treat all contributors with respect. Constructive feedback is always encouraged and helps making the software better.
• Maintain a Positive Environment: A welcoming environment is great for possible newcomers and encourage them to contribute if they have fixes or ideas.
• Issue Reporting: If you find any bugs or issues, please report them in the issues section of the GitHub repository. Include as much detail as possible, as it will make the issue easy to understand.

Thank You!

Your contributions are what make Clipboardy a better programm for everyone! Thank you for your interest in contributing to this project and your effort!

GitHub 🔗

Clipboardy is an open-source project hosted on GitHub. You can check out the codebase and contribute at: