Metadata-Version: 2.3
Name: nqrduck-module
Version: 0.0.2
Summary: A template for nqrduck modules. Also used for testing.
Project-URL: Homepage, https://nqrduck.cool
Project-URL: Bug Tracker, https://github.com/nqrduck/nqrduck-module/issues
Project-URL: Source Code, https://github.com/nqrduck/nqrduck-module
Author-email: jupfi <support@nqrduck.cool>
License: MIT License
        
        Copyright (c) 2023 jupfi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: matplotlib
Requires-Dist: nqrduck
Requires-Dist: pyqt6
Description-Content-Type: text/markdown

# NQRduck Module: $MODULE_NAME

This module  is a template for the creation of new modules. It provides a basic structure for the creation of new modules.
This Readme file should be used as a template for the README.md file of new modules.
Add a short description of the module here but describe the usage in the Usage section.

## Installation

### Requirements
Describe the requirements for the module. Usually dependencies are handled via the pyproject.toml file but if the user needs to install additional software or libraries, it should be mentioned here. Also mention that the user needs to install the NQRduck core.

### Setup
Describe how to install the module. Usually the user needs to install the NQRduck core first. Then the user can install the module by running the following command in the terminal:
```bash
pip install .
```

## Usage
Describe how to use the module. This should include a short description of the module and how it is used together with the NQRduck core.
If it's an UI module ideally include a screenshot of the UI.

### Notes
Add additional notes here. This could be information about the usage of the module or additional information about the module.

## License
Usually the modules are licensed under the MIT License. The license file should be included in the module. The license file should be named LICENSE and should be in the root directory of the module.

## Contributing
If you're interested in contributing to the project, start by checking out our [nqrduck-module template](https://github.com/nqrduck/nqrduck-module). To contribute to existing modules, please first open an issue in the respective module repository to discuss your ideas or report bugs.
```