A system tray application for controlling headsets, particularly those compatible with headsetcontrol.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Python 3.10 or higher
uv(a fast Python package installer and resolver)
You can install uv using pip:
pip install uvAlternatively, you can use the official installer script:
curl -LsSf https://astral.sh/uv/install.sh | shMake sure to add uv to your PATH if it's not already. If you installed with pip as a user, this might be ~/.local/bin.
-
Clone the repository (if you haven't already):
git clone <repository-url> cd <repository-directory>
-
Initialize the project and create a virtual environment: If you are setting up the project for the first time using
uv, it can initialize the project structure. However, since you've cloned an existing project, you'll primarily useuvto manage the environment and dependencies.Create a virtual environment:
uv venv
This will create a
.venvdirectory in the project root. -
Activate the virtual environment: On macOS and Linux:
source .venv/bin/activateOn Windows:
.venv\Scripts\activate
-
Install dependencies: The project dependencies are defined in
pyproject.toml. To install them usinguv:uv pip sync
If the project uses extras, you might use:
uv pip sync --all-extras
-
Adding new dependencies: To add a new runtime dependency:
uv add <package-name>
To add a new development dependency:
uv add --dev <package-name>
This will update your
pyproject.tomland install the package.
To run the application:
python -m headsetcontrol_trayAlternatively, you can use uv to run scripts defined in pyproject.toml (if any) or execute commands within the managed environment:
uv run python -m headsetcontrol_trayPlease read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE.md file for details.