LPShub

A centralized hub designed to simplify the addition, execution, and management of local Python scripts on your computer.

v.0.1

Table of Contents

• Installation
• Usage
• Features
• Motivation
• Contributing
• License

Installation

Note: This project utilizes PySimpleGUI, so if this is your first time using this library, please follow the steps outlined in PySimpleGUI documentation.

Clone the project repository:

git clone https://github.com/thigazzz/LPShub.git
cd LPShub

Create a virtual environment and activate it:

python3 -m venv .venv

or

virtualenv .venv

Activate the virtual environment:

• On Windows:

.venv\Scripts\activate

• On Unix or MacOS:

source .venv/bin/activate

Install the project dependencies:

pip install -r requirements.txt

Now you're all set up and ready to use LPShub!

Usage

Run the app:

python app.py

or with Python 3:

python3 app.py

Here's how the application looks when it starts, with two sections: 'Script' with a section to add a script and 'Help' with information about the project.

To add a script, click on 'Script' and then 'Add' in the menu.

A window will open to add information about the script: Name, File Path, and Virtual Environment Path. Note: If the script doesn't have a virtual environment, leave the field blank.

Now simply click on 'Adicionar script'.

The window will close, redirecting to the initial window, now with your script ready to be executed, simply click on 'Executar script'.

Features

• Run scripts
• Add a script
• Delete a script
• Update a script
• Create a group of related scripts

Motivation

Despite efficiently organizing my small scripts on my computer, the process of navigating to the script location and executing them by entering the same two commands (to activate the virtual environment and run the script) became tedious. To address this inconvenience, I initiated this project, hoping that it could be beneficial for others facing a similar challenge.

Contributing

We welcome contributions from the community to improve and enhance this project. By contributing to this repository, you agree to abide by the following guidelines:

How to Contribute

1. Fork the repository and create your branch from main.
2. Make your changes, ensuring that your code follows the project's coding style and conventions.
3. Test your changes thoroughly to ensure they function as expected.
4. Commit your changes with clear and descriptive commit messages.
5. Push your changes to your fork.
6. Open a pull request to merge your changes into the main repository.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License. See LICENSE for more information.

Questions or Need Help?

If you have any questions or need assistance, feel free to open an issue or contact the project maintainers.

Thank you for your contributions!