UINEX

Create modern looking GUIs with pygame.

Table of Contents

• 📍 Overview
• 🚀 Getting Started
  • ⚙️ Installation
  • 🤖 Example
  • ☑️ Dependencies
• 🔰 Contributing

• 📃 License

📍 Overview

uinex is a library for building

Documentation: https://github.io/djoezeke/uinex

Source Code: https://github.com/djoezeke/uinex

🚀 Getting Started

Use uv for local development and running examples/tests.

⚙️ Installation

Install using pip:

$ pip install uinex

This will install uinex with minimal dependencies.

$ pip install 'uinex[standard]'

Install project dependencies for contributors using uv:

$ uv sync

Run tests with uv:

$ uv run pytest -q

🤖 Example

Run the included examples with uv:

$ uv run python -m examples.simple
$ uv run python -m examples.showcase
$ uv run python -m examples.customization
$ uv run python -m examples.theming
$ uv run python -m examples.ui_samples

☑️ Dependencies

uinex stands on the shoulders of a giant. Its only internal required dependency is Pygame.

By default it also comes with extra standard dependencies:

• pygame: to show draw widgets.

• pillow: for image loading.

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the uinex project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone --recursive https://github.com/djoezeke/uinex

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

📃 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.