/PotatoWidgets

Widget system written in Python for x11 and Wayland, using GTK+ and the GtkLayerShell.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Welcome to PotatoWidgets 🥔✨

PotatoWidgets simplifies Python's interaction with GTK, offering a straightforward framework for creating graphical user interfaces effortlessly.

Why PotatoWidgets?

  • Pythonic Configuration: Entirely configured in Python (and SCSS for added beauty), PotatoWidgets leverages Python's extensive library ecosystem, empowering you with all the tools you need for seamless development.
  • Built-in Functions and Services: PotatoWidgets makes development easier by providing built-in functions and services to interact with your system, eliminating the need for external scripting.
  • Various Examples: Find illustrative examples for various functionalities on the project's wiki. If not available, you're welcome to contribute and help expand the library of examples. Check out the contributing guide to get started!

Installation

pip install git+https://github.com/T0kyoB0y/PotatoWidgets.git

Peek into My Setup

BSPWM

BSPWM Setup

Hyprland

Hyprland Setup 1 Hyprland Setup 2 Hyprland Setup 3

Ready to Contribute?

Thank you for considering contributing to PotatoWidgets! Here's how you can get started:

Contributing to the Code

  1. Fork the repository: Click on the 'Fork' button on the top-right corner of this page.
  2. Code: Make your desired changes to the codebase.
  3. Push your changes: Push your changes to your forked repository.
  4. Submit a pull request: Go to the original repository and click on the 'New pull request' button. Describe your changes and submit the pull request.

Contributing to the Wiki

Wanna contribute to the wiki? Here are some ways you can help:

  • Document new features: Add documentation for new features.
  • Update existing documentation: Ensure that existing documentation is accurate and up-to-date.
  • Write tutorials: Create tutorials or guides to help users understand how to use PotatoWidgets effectively.
  • Provide examples: Add code snippets or full examples to illustrate usage.

Feel free to add any examples or detailed explanations you think would be helpful!

Thank you for your contributions! 🥔🚀

"potato widgets can be resumed as 'the joke went to far, cannot stop now'"
-- λ.midnight