Metadata-Version: 2.4
Name: jarvis-bot
Version: 7.1.2
Summary: Voice-Activated Natural Language UI
Author-email: Vignesh Rao <svignesh1793@gmail.com>
License: MIT License
        
        Copyright (c) 2020 Vignesh Rao
        
        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.
        
Project-URL: API, https://jarvis.vigneshrao.com
Project-URL: Health, https://jarvis-health.vigneshrao.com
Project-URL: Homepage, https://github.com/thevickypedia/Jarvis
Project-URL: Docs, https://jarvis-docs.vigneshrao.com
Project-URL: Demo, https://vigneshrao.com/Jarvis/Jarvis_Demo.mp4
Project-URL: Source, https://github.com/thevickypedia/Jarvis
Project-URL: Bug Tracker, https://github.com/thevickypedia/Jarvis/issues
Project-URL: Release Notes, https://github.com/thevickypedia/Jarvis/blob/master/release_notes.rst
Keywords: python,home-automation,natural-language-processing,text-to-speech,speech-recognition,jarvis,hotword-detection,virtual-assistant
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Information Technology
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Home Automation
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: System :: Hardware :: Universal Serial Bus (USB) :: Wireless Controller
Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Classifier: Topic :: System :: Hardware :: Symmetric Multi-processing
Classifier: Framework :: AnyIO
Classifier: Framework :: FastAPI
Classifier: Framework :: AsyncIO
Classifier: Framework :: Pydantic :: 2
Classifier: Framework :: Setuptools Plugin
Classifier: Framework :: aiohttp
Classifier: Natural Language :: English
Requires-Python: <3.12,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: sphinx==5.1.1; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: recommonmark; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: gitverse; extra == "dev"
Dynamic: license-file

<p align="center" style="text-align: center">
  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px" alt="logo">
</p>
<h2 align="center">Voice-Activated Natural Language UI</h2>

[![made-with-python][label-python]][python]

![Python][label-pyversion]
[![OpenSSF Scorecard][label-open-ssf]][link-open-ssf]

**Platform Supported**

![Platform][label-platform]

**Language Stats**

![Language count][label-language-ct]
![Code coverage][label-code-coverage]

**[Repo Stats][repo]**

[![GitHub][label-license]][license]

![GitHub Repo stars][label-stars]
![GitHub Repo forks][label-forks]
![GitHub Repo watchers][label-watchers]

![GitHub repo size][label-repo-size]

![GitHub Repo issues][label-issues-closed]
![GitHub Repo issues][label-issues-raw]
![GitHub Repo pr][label-pr-closed]
![GitHub Repo pr][label-pr-raw]

**Code Stats**

![GitHub file count][label-file-count]
![GitHub code size][label-code-size]
![GitHub code line][label-code-line]

**Deployments**

[![pages][label-actions-pages]][gha_pages]
[![pypi][label-actions-pypi]][gha_pypi]
[![markdown][label-actions-markdown]][gha_md_valid]
[![update-release-notes][label-actions-release]][gha_release_notes]

**jarvis-ironman**

![Pypi-downloads][label-pypi-downloads-jarvis-ironman]
[![Pypi][label-pypi-jarvis-ironman]][pypi-jarvis-ironman]
[![Pypi-format][label-pypi-format-jarvis-ironman]][pypi-files]
[![Pypi-status][label-pypi-status-jarvis-ironman]][pypi-jarvis-ironman]

**jarvis-nlp**

![Pypi-downloads][label-pypi-downloads-jarvis-nlp]
[![Pypi][label-pypi-jarvis-nlp]][pypi-jarvis-nlp]
[![Pypi-format][label-pypi-format-jarvis-nlp]][pypi-files]
[![Pypi-status][label-pypi-status-jarvis-nlp]][pypi-jarvis-ironman]

**jarvis-bot**

![Pypi-downloads][label-pypi-downloads-jarvis-bot]
[![Pypi][label-pypi-jarvis-bot]][pypi-jarvis-bot]
[![Pypi-format][label-pypi-format-jarvis-bot]][pypi-files]
[![Pypi-status][label-pypi-status-jarvis-bot]][pypi-jarvis-bot]

**natural-language-ui**

![Pypi-downloads][label-pypi-downloads-natural-language-ui]
[![Pypi][label-pypi-natural-language-ui]][pypi-natural-language-ui]
[![Pypi-format][label-pypi-format-natural-language-ui]][pypi-files]
[![Pypi-status][label-pypi-status-natural-language-ui]][pypi-natural-language-ui]

**Activity**

![GitHub Repo created][label-github-repo-created]
![GitHub commit activity][label-github-commit-activity]
![GitHub last commit][label-github-last-commit]
![GitHub last release][label-github-last-release]

**Development and Maintenance**

![Active Development][label-active-development]
![Actively Maintained][label-actively-maintained]
[![Maintainer][label-maintainer]][webpage]

**Reach Out**

[![askme][label-askme]][webpage_contact]

## Kick off

**Recommendations**

- Install `python` [3.10] or [3.11]
- Use a dedicated [virtual environment]

**Install Jarvis**
```shell
python -m pip install jarvis-ironman
```

**Install Dependencies**
```shell
jarvis install
```

**Initiate - IDE**
```python
import jarvis


if __name__ == '__main__':
    jarvis.start()
```

**Initiate - CLI**
```shell
jarvis start
```

> Use `jarvis --help` for usage instructions.

## Prerequisites
   - **MacOS** <br> _Tested on **Mojave, Catalina, Big Sur, Monterey and Ventura**_
     - `System Preferences` → `Security & Privacy` → `Privacy`
     - Click `+` sign and add the preferred `IDE` and `Terminal` in the following sections in left pane.
       - `Microphone` - **Required** to listen and respond.
       - `Accessibility` - **Required** to use key combinations for brightness and volume controls.
       - `Camera` - **[Optional]** Required only during face recognition/detection.
       - `Automation` - **Required** to control `System Events` and other apps like Outlook and Calendar.
       - `Files and Folders` **[OR]** `Full Disk Access` - **Required** for all `FileIO` operations.

   - **Linux** <br> _Tested on **Ubuntu 22.04 LTS**_
     - Store the host machine's password as the env var: `ROOT_PASSWORD`
     - Unlike macOS and Windows, `Ubuntu` does not have app specific permissions.

   - **Windows** <br> _Tested on **Windows 10**_
     - `Settings` → `Privacy`
       - `Microphone` - **Required** to listen and respond.
       - `Camera` - **[Optional]** Required only during face recognition/detection.
       - Unlike `macOS`, `Windows` pops a confirmation window to **Allow** or **Deny** access to files and folders.
     - Install [Anaconda] or [Miniconda], [VisualStudio C++ BuildTools][vcpp], and [Git][git-cli]
     - Make sure C++ build tools are installed completely and restart
     - Add anaconda/miniconda scripts location to `PATH` in Environment Variables

## Enchiridion
Handbook - [GitHub Wiki][wiki]

## Coding Standards
Docstring format: [`Google`][google-docs] <br>
Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]

## [Release Notes][release-notes]
**Requirement**
```shell
python -m pip install gitverse
```

**Usage**
```shell
gitverse-release reverse -f release_notes.rst -t 'Release Notes'
```

## Linting
`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL
markdown files (including Wiki pages)

**Requirement**
```shell
python -m pip install sphinx==5.1.1 pre-commit recommonmark
```

**Usage**
```shell
pre-commit run --all-files
```

## Pypi Package
[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-repo]

- [https://pypi.org/project/jarvis-ironman/][pypi-jarvis-ironman]
- [https://pypi.org/project/jarvis-nlp/][pypi-jarvis-nlp]
- [https://pypi.org/project/jarvis-bot/][pypi-jarvis-bot]
- [https://pypi.org/project/natural-language-ui/][pypi-natural-language-ui]

## Runbook
[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx]

[https://jarvis-docs.vigneshrao.com/][runbook]

## License & copyright

&copy; Vignesh Rao

Licensed under the [MIT License][license]

[python]: https://python.org
[3.10]: https://docs.python.org/3/whatsnew/3.10.html
[3.11]: https://docs.python.org/3/whatsnew/3.11.html
[virtual environment]: https://docs.python.org/3/tutorial/venv.html
[PyCharm]: https://www.jetbrains.com/pycharm/
[VSCode]: https://code.visualstudio.com/download
[repo]: https://api.github.com/repos/thevickypedia/Jarvis
[license]: https://github.com/thevickypedia/Jarvis/blob/master/LICENSE
[pypi-jarvis-ironman]: https://pypi.org/project/jarvis-ironman
[pypi-jarvis-nlp]: https://pypi.org/project/jarvis-nlp
[pypi-jarvis-bot]: https://pypi.org/project/jarvis-bot
[pypi-natural-language-ui]: https://pypi.org/project/natural-language-ui
[pypi-files]: https://pypi.org/project/jarvis-ironman/#files
[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
[wiki]: https://github.com/thevickypedia/Jarvis/wiki
[release-notes]: https://github.com/thevickypedia/Jarvis/blob/master/release_notes.rst
[gha_pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment
[gha_pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/matrix-publisher.yml
[gha_md_valid]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml
[gha_release_notes]: https://github.com/thevickypedia/Jarvis/actions/workflows/release_notes.yml
[webpage]: https://vigneshrao.com/
[webpage_contact]: https://vigneshrao.com/contact
[Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/
[Miniconda]: https://docs.conda.io/en/latest/miniconda.html#windows-installers
[vcpp]: https://visualstudio.microsoft.com/visual-cpp-build-tools/
[git-cli]: https://git-scm.com/download/win/
[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
[pep8]: https://www.python.org/dev/peps/pep-0008/
[isort]: https://pycqa.github.io/isort/
[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
[runbook]: https://jarvis-docs.vigneshrao.com/

<!-- labels -->

[label-python]: https://img.shields.io/badge/Made%20with-Python-blue?style=for-the-badge&logo=Python
[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange
[label-pypi-downloads-jarvis-ironman]: https://img.shields.io/pypi/dm/jarvis-ironman
[label-pypi-downloads-jarvis-nlp]: https://img.shields.io/pypi/dm/jarvis-nlp
[label-pypi-downloads-jarvis-bot]: https://img.shields.io/pypi/dm/jarvis-bot
[label-pypi-downloads-natural-language-ui]: https://img.shields.io/pypi/dm/natural-language-ui
[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg

[label-language-ct]: https://img.shields.io/github/languages/count/thevickypedia/Jarvis
[label-code-coverage]: https://img.shields.io/github/languages/top/thevickypedia/Jarvis

[label-license]: https://img.shields.io/github/license/thevickypedia/Jarvis

[label-stars]: https://img.shields.io/github/stars/thevickypedia/Jarvis
[label-forks]: https://img.shields.io/github/forks/thevickypedia/Jarvis
[label-watchers]: https://img.shields.io/github/watchers/thevickypedia/Jarvis

[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Jarvis
[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Jarvis
[label-code-line]: http://jarvis.vigneshrao.com/line-count?badge=true
[label-file-count]: http://jarvis.vigneshrao.com/file-count?badge=true

[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Jarvis
[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Jarvis
[label-pr-closed]: https://img.shields.io/github/issues-pr-closed-raw/thevickypedia/Jarvis
[label-pr-raw]: https://img.shields.io/github/issues-pr-raw/thevickypedia/Jarvis

[label-actions-pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment/badge.svg
[label-actions-pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/matrix-publisher.yml/badge.svg
[label-actions-markdown]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml/badge.svg
[label-actions-release]: https://github.com/thevickypedia/Jarvis/actions/workflows/release_notes.yml/badge.svg

[label-pypi-jarvis-ironman]: https://img.shields.io/pypi/v/jarvis-ironman
[label-pypi-format-jarvis-ironman]: https://img.shields.io/pypi/format/jarvis-ironman
[label-pypi-status-jarvis-ironman]: https://img.shields.io/pypi/status/jarvis-ironman

[label-pypi-jarvis-bot]: https://img.shields.io/pypi/v/jarvis-bot
[label-pypi-format-jarvis-bot]: https://img.shields.io/pypi/format/jarvis-bot
[label-pypi-status-jarvis-bot]: https://img.shields.io/pypi/status/jarvis-bot

[label-pypi-jarvis-nlp]: https://img.shields.io/pypi/v/jarvis-nlp
[label-pypi-format-jarvis-nlp]: https://img.shields.io/pypi/format/jarvis-nlp
[label-pypi-status-jarvis-nlp]: https://img.shields.io/pypi/status/jarvis-nlp

[label-pypi-natural-language-ui]: https://img.shields.io/pypi/v/natural-language-ui
[label-pypi-format-natural-language-ui]: https://img.shields.io/pypi/format/natural-language-ui
[label-pypi-status-natural-language-ui]: https://img.shields.io/pypi/status/natural-language-ui

[label-github-repo-created]: https://img.shields.io/date/1599432310
[label-github-commit-activity]: https://img.shields.io/github/commit-activity/y/thevickypedia/Jarvis
[label-github-last-commit]: https://img.shields.io/github/last-commit/thevickypedia/Jarvis
[label-github-last-release]: https://img.shields.io/github/release-date/thevickypedia/Jarvis

[label-active-development]: https://img.shields.io/badge/Development%20Level-Actively%20Developed-success.svg
[label-actively-maintained]: https://img.shields.io/badge/Maintenance%20Level-Actively%20Maintained-success.svg
[label-maintainer]: https://img.shields.io/badge/Maintained%20By-Vignesh%20Rao-blue.svg

[label-askme]: https://img.shields.io/badge/SELECT%20*%20FROM-questions-1abc9c.svg

[label-open-ssf]: https://api.securityscorecards.dev/projects/github.com/thevickypedia/Jarvis/badge
[link-open-ssf]: https://securityscorecards.dev/viewer/?uri=github.com/thevickypedia/Jarvis
