Contributing
We welcome contributions to the OpenWebUI client library! This document provides guidelines and instructions for contributing.
Development Setup
- Clone the repository:
- Create and activate a virtual environment:
- Install the package in development mode:
Code Style
We use the following tools to maintain code quality:
- Black: For code formatting
- isort: For import sorting
- mypy: For static type checking
- flake8: For code style enforcement
You can run these tools using pre-commit:
Running Tests
Run the tests with pytest:
For tests with coverage:
Building Documentation
To build the documentation:
The documentation will be available in the site
directory.
Submitting Changes
- Create a branch for your changes:
- Make your changes and commit them:
- Push your changes to your fork:
- Open a pull request against the main repository.