Metadata-Version: 2.4
Name: nectarstt
Version: 0.1.0
Summary: Nectar Speech-to-Text And Text-to-Speech Engine
Author-email: Headlessripper <zashiron.inc@gmail.com>
License: <<<<<<< HEAD
        NectarSTT Proprietary License (Zashiron License v1.2)
        Copyright © 2025 Zashiron. All rights reserved.
        
        1. Definitions
        “Software” means the computer program known as NectarSTT,
        including all executable code, source code, scripts, assets, documentation,
        updates, and related materials provided by Zashiron.
        
        “Licensee” (or “You”) means any person or legal entity authorized by Zashiron
        to use the Software under this License.
        
        “Use” means to install, execute, access, or otherwise interact with the Software.
        
        2. Grant of License
        Subject to the terms of this License, Zashiron grants You a non-exclusive,
        non-transferable, revocable license to install and use one copy of the Software
        for personal, educational, or approved commercial purposes.
        All other rights are reserved by Zashiron.
        
        3. Commercial Use
        You may use the Software for commercial purposes only if you have obtained an
        official commercial license or written authorization from Zashiron, and comply
        with all fees and conditions. Unauthorized commercial use is strictly prohibited.
        
        4. Restrictions
        You may not:
        - Copy, modify, or create derivative works of the Software.
        - Distribute, sublicense, rent, lease, lend, or resell the Software.
        - Circumvent or bypass licensing or activation mechanisms.
        - Remove or alter any copyright or proprietary notices.
        - Use the Software for illegal, unethical, or competing purposes.
        
        5. Ownership
        All rights, title, and interest in the Software remain the exclusive property of Zashiron.
        
        6. Updates and Support
        Zashiron may, at its discretion, provide updates, patches, or enhancements.
        Such updates remain governed by this License.
        
        7. Termination
        This License is effective until terminated. Upon termination, You must cease use
        and destroy all copies of the Software.
        
        8. Disclaimer of Warranties
        The Software is provided “AS IS”, without warranties of any kind, express or implied.
        
        9. Limitation of Liability
        In no event shall Zashiron be liable for any direct, indirect, incidental, or
        consequential damages arising from use or inability to use the Software.
        
        10. Governing Law
        This License is governed by the laws of the Republic of South Africa.
        
        11. Commercial Licensing Inquiries
        For enterprise or commercial licensing:
        Zashiron Licensing Department
        Email: Zashiron.inc@gmail.com
        Website: https://github.com/Zashiron
        
        12. Acknowledgment
        By installing or using the Software, You agree to be bound by this License.
        
        13. Anti-Decompilation Clause
        You expressly agree not to reverse engineer, decompile, disassemble, decrypt,
        modify, or otherwise attempt to derive the source code or algorithms of the Software,
        except where such activity is expressly permitted by law. Any unauthorized attempt
        constitutes a material breach and may result in termination and legal action.
        
        14. Data Privacy
        Zashiron is committed to protecting your privacy. We do not collect or store any personal data without your consent. Any data collected during the use of the Software is used solely for the purpose of providing and improving the Software.
        =======
        NectarSTT Proprietary License (Zashiron License v1.2)
        Copyright © 2025 Zashiron. All rights reserved.
        
        1. Definitions
        “Software” means the computer program known as NectarSTT,
        including all executable code, source code, scripts, assets, documentation,
        updates, and related materials provided by Zashiron.
        
        “Licensee” (or “You”) means any person or legal entity authorized by Zashiron
        to use the Software under this License.
        
        “Use” means to install, execute, access, or otherwise interact with the Software.
        
        2. Grant of License
        Subject to the terms of this License, Zashiron grants You a non-exclusive,
        non-transferable, revocable license to install and use one copy of the Software
        for personal, educational, or approved commercial purposes.
        All other rights are reserved by Zashiron.
        
        3. Commercial Use
        You may use the Software for commercial purposes only if you have obtained an
        official commercial license or written authorization from Zashiron, and comply
        with all fees and conditions. Unauthorized commercial use is strictly prohibited.
        
        4. Restrictions
        You may not:
        - Copy, modify, or create derivative works of the Software.
        - Distribute, sublicense, rent, lease, lend, or resell the Software.
        - Circumvent or bypass licensing or activation mechanisms.
        - Remove or alter any copyright or proprietary notices.
        - Use the Software for illegal, unethical, or competing purposes.
        
        5. Ownership
        All rights, title, and interest in the Software remain the exclusive property of Zashiron.
        
        6. Updates and Support
        Zashiron may, at its discretion, provide updates, patches, or enhancements.
        Such updates remain governed by this License.
        
        7. Termination
        This License is effective until terminated. Upon termination, You must cease use
        and destroy all copies of the Software.
        
        8. Disclaimer of Warranties
        The Software is provided “AS IS”, without warranties of any kind, express or implied.
        
        9. Limitation of Liability
        In no event shall Zashiron be liable for any direct, indirect, incidental, or
        consequential damages arising from use or inability to use the Software.
        
        10. Governing Law
        This License is governed by the laws of the Republic of South Africa.
        
        11. Commercial Licensing Inquiries
        For enterprise or commercial licensing:
        Zashiron Licensing Department
        Email: Zashiron.inc@gmail.com
        Website: https://github.com/Zashiron
        
        12. Acknowledgment
        By installing or using the Software, You agree to be bound by this License.
        
        13. Anti-Decompilation Clause
        You expressly agree not to reverse engineer, decompile, disassemble, decrypt,
        modify, or otherwise attempt to derive the source code or algorithms of the Software,
        except where such activity is expressly permitted by law. Any unauthorized attempt
        constitutes a material breach and may result in termination and legal action.
        
        14. Data Privacy
        Zashiron is committed to protecting your privacy. We do not collect or store any personal data without your consent. Any data collected during the use of the Software is used solely for the purpose of providing and improving the Software.
        >>>>>>> efc3e6b3fcb5271f8a2c63eb73b34038807b5a4d
        By using the Software, You acknowledge that You have read, understood, and agree to be bound by the terms of this License.
Project-URL: Homepage, https://github.com/headlessripper/NectarSTT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyQt6
Requires-Dist: PyQt6-Qt6
Requires-Dist: PyQt6-sip
Requires-Dist: sounddevice
Requires-Dist: scipy
Requires-Dist: numpy
Requires-Dist: click
Dynamic: license-file

# 🍯 NectarSTT  
**Nectar Speech-to-Text Engine**

NectarSTT (Nectar Speech To Text) is a Python-based speech recognition engine designed for real-time, offline-capable voice input. It is built to be modular, extensible, and suitable for AI assistants, automation systems, and accessibility tools.

This project focuses on **accurate speech recognition**, **low latency**, and **tight integration with AI pipelines**.

---

## ✨ Features

- 🎙️ Real-time speech-to-text
- 🧠 Modular engine design (easy to extend)
- ⚡ Optimized for low latency
- 🔌 Designed to integrate with AI / assistant systems
- 🖥️ Cross-platform (Windows, Linux)
- 🧩 Compatible with TTS pipelines (Piper / eSpeak NG)

---

## 📁 Project Structure
```
NectarSTT/
│
├── Production/
|   ├── InnoScript/ 
|   |   └── NectarSTT.iss
|   ├── icons8-speak-48
|   ├── LICENSE
|   ├── NectarSTT.reg
|   ├── postinstall.txt
|   └── preinstall.txt
|
├── Main-Engine/
│ ├── STT-Engine/ # Speech-to-text core
│ ├── TTS-Engine/ # Text-to-speech core
│ ├── Model/ # Speech models 
| ├── Sound/ # Sound Effects
| ├── Source/ # Test Code
│ └── Images/ # UI / assets
│
├── .gitignore
├── README.md
├── Main.py
└── requirements.txt
```
> ⚠️ **Note:** Large models and voice data are present in Realese.

---

## 🛠️ Installation

### 1️⃣ Clone the repository
```bash
git clone https://github.com/headlessripper/NectarSTT.git
cd NectarSTT
```
---

### 2️⃣ Create a virtual environment (recommended)
python -m venv venv
venv\Scripts\activate 

### 3️⃣ Install dependencies
pip install -r requirements.txt


---

## 📦 Models & Assets

Due to GitHub size limits, speech models and voice data are zipped into **Main-Engine.zip**.  
This archive contains:

- `Main-Engine/Model/`
- `Main-Engine/TTS-Engine/`

Extract `Main-Engine.zip` into the project directory before running NectarSTT.

> 💡 A setup script or model downloader may be added in future releases.

---

### ▶️ Usage

Example (basic run):

- `python main.py`

Or import as a module:

- `from nectar_stt import recognize_speech`
```
text = recognize_speech()
print(text)
```
---

## ⚙️ Configuration

You can configure:

- 🎤 Microphone device
- ⏱️ Timeout values
- 🌐 Language
- 🧠 Model selection

These settings can be adjusted in the engine UI or directly in the code, depending on your integration needs.


---

## 🚀 Roadmap / Ideas

- Automated model download & setup script
- Extended TTS engine support
- Additional language models
- Optional Futher GPU acceleration (where supported)
- Enhanced logging and debugging tools

---

## 🤝 Contributing

Contributions are welcome!

You can:

- 🐛 Report bugs
- 💡 Suggest new features
- 🔧 Submit pull requests

Please open an issue to discuss major changes before starting work.

---

## 📜 License
Use a Custom License
---

## ⭐ Support

If you find **NectarSTT** useful:

- ⭐ Star the repository
- 🐞 Report issues
- 💬 Share feedback and ideas

---

**Built with ❤️ in Python for high-quality, low-latency speech recognition.**
