davidgg-dev/vumetergg

Vu meter for PySide6, compatible with QT Designer.

VuMeterGG

VuMeterGG is a Qt Designer widget developed with PySide6. It captures audio from the microphone and displays it through a graphical representation. It includes many parameters to customize how the graphical representation of the sound is displayed and to calibrate it.

Installation

You can use VuMeterGG, directly with PySide6 in your Python project, or you can integrate it into your graphical interface by promoting custom widgets from Qt Designer.

QT Designer

1. Place the vu_meter_gg.py file in your project. In the demo, it is located in demo/view/qt_ui/promoted/vu_meter_gg.py.
2. From QT Designer, insert a QWidget.
3. Promote the QWidget to VuMeterGG:
   • Insert VuMeterGG in the name field.
   • Use the file path without its extension in the header file field. In the demo, it is view/qt_ui/promoted/vu_meter_gg.

Directly

Create an instance of VuMeterGG and place it in your layout.

To configure the vu meter call the methods through the name you gave to the widget or modify the attributes directly from the vu_meter_gg.py file

Config

To configure the vu meter, call the methods through the name you gave to the widget or modify the attributes directly in the vu_meter_gg.py file.

Documentation

A manual for version v0.1.0-beta is available in Spanish. You can download it here.

Requirements

• PyAudio
• PySide6
• PySide6-Addons
• PySide6-Essentials
• shiboken6

Contributors ✨

Thanks go to these wonderful people (emoji key):

David García González 🚧 💻

José Valentino 🤔

This project follows the all-contributors specification. Contributions of any kind are welcome!

How to contribute

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch
3. Make your changes and commit them
4. Push to the branch.
5. Open a pull request.

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Thank you for your contributions!

Please read the CONTRIBUTING.md file for details on how to contribute to this project.

Code of Conduct

Please read the CODE_OF_CONDUCT.md file for more details on our code of conduct.

Third-Party Licenses

• PyAudio
• Qt5
• PySide6
• QDarkStyleSheet

For more details, see the THIRD_PARTY_LICENSES.md file.

License

VuMeterGG is distributed under the GNU Lesser General Public License v3.0 only.

For more details, see the LICENSE.md file.

vumetergg's Issues

Update the Demo Project to Work with the New Function Names

Modify the demo project to ensure it works correctly with the updated function and variable names. This includes updating any references in the demo code and ensuring that all functionality remains intact.

Update Comments with the New Names and Translate Them into English

Update all comments in the codebase to reflect the new function and variable names. Additionally, translate all comments into English to ensure consistency and readability for an international audience.

Update method and variable names to PEP 8 conventions in English and make them more descriptive if needed

Update all method and variable names in the codebase to follow PEP 8 conventions. Translate names to English and make them more descriptive where necessary to improve code readability and maintainability.

• Target Files: src/vu_meter_gg.py
• Create a file that documents the old function and variable names along with their new replacements. This document is essential for completing the remaining issues in the milestone.

Note: According to PEP 8, variable and method names should be in snake_case, and constants should be in UPPER_CASE.

Create Usage Documentation

Develop comprehensive usage documentation for the project. This documentation should include installation instructions, usage examples, and explanations of key features and functions.

Code documentation

Did you consider using pdoc to generate the code documentation automatically?
https://pdoc3.github.io/pdoc/

Install

pip install pdoc3

Usage

pdoc --html pdoc