| Name | jarvis-ironman JSON |
| Version |
4.4.2
JSON |
| download |
| home_page | |
| Summary | Voice-Activated Natural Language UI |
| upload_time | 2024-02-03 06:06:49 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| 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. |
| keywords |
python
home-automation
natural-language-processing
text-to-speech
speech-recognition
jarvis
hotword-detection
virtual-assistant
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center" style="text-align: center">
<img src="https://vigneshrao.com/Jarvis/logo.png" width="371px" height="350px">
</p>
<h2 align="center">Voice-Activated Natural Language UI</h2>
[][python]
**Platform Supported**
**Language Stats**
**[Repo Stats][repo]**
[][license]
**Code Stats**
**Deployments**
[][gha_pages]
[][gha_pypi]
[][gha_md_valid]
[][pypi]
[](https://pypi.org/project/jarvis-ironman/#files)
[][pypi]
**Activity**
**Development and Maintenance**
[][webpage]
**Reach Out**
[][webpage_contact]
## Kick off
> :bulb: Using a dedicated [virtual environment][venv] and an IDE like [PyCharm][pycharm] is highly recommended.
**Install**
```shell
python -m pip install jarvis-ironman
```
**Initiate**
```python
import jarvis
if __name__ == '__main__':
jarvis.start()
```
## Prerequisites
- **MacOS** <br> _Tested on **macOS High Sierra, 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][conda] or [Miniconda][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
pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
## Pypi Package
[][pypi-repo]
[https://pypi.org/project/jarvis-ironman/][pypi]
## Runbook
[][sphinx]
[https://jarvis-docs.vigneshrao.com/][runbook]
## License & copyright
© Vignesh Rao
Licensed under the [MIT License][license]
[python]: https://python.org
[venv]: https://docs.python.org/3/tutorial/venv.html
[pycharm]: https://www.jetbrains.com/pycharm/
[repo]: https://api.github.com/repos/thevickypedia/Jarvis
[license]: https://github.com/thevickypedia/Jarvis/blob/master/LICENSE
[pypi]: https://pypi.org/project/jarvis-ironman
[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/python-publish.yml
[gha_md_valid]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown-validation.yml
[webpage]: https://vigneshrao.com/
[webpage_contact]: https://vigneshrao.com/contact
[conda]: 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/
Raw data
{
"_id": null,
"home_page": "",
"name": "jarvis-ironman",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "python,home-automation,natural-language-processing,text-to-speech,speech-recognition,jarvis,hotword-detection,virtual-assistant",
"author": "",
"author_email": "Vignesh Rao <svignesh1793@gmail.com>",
"download_url": "",
"platform": null,
"description": "<p align=\"center\" style=\"text-align: center\">\n <img src=\"https://vigneshrao.com/Jarvis/logo.png\" width=\"371px\" height=\"350px\">\n</p>\n<h2 align=\"center\">Voice-Activated Natural Language UI</h2>\n\n[][python]\n\n\n\n\n**Platform Supported**\n\n\n\n**Language Stats**\n\n\n\n\n**[Repo Stats][repo]**\n\n[][license]\n\n\n\n\n\n\n\n\n\n\n\n\n\n**Code Stats**\n\n\n\n\n\n\n\n\n\n\n**Deployments**\n\n[][gha_pages]\n[][gha_pypi]\n[][gha_md_valid]\n\n[][pypi]\n[](https://pypi.org/project/jarvis-ironman/#files)\n[][pypi]\n\n**Activity**\n\n\n\n\n\n\n**Development and Maintenance**\n\n\n\n[][webpage]\n\n**Reach Out**\n\n[][webpage_contact]\n\n## Kick off\n\n> :bulb: Using a dedicated [virtual environment][venv] and an IDE like [PyCharm][pycharm] is highly recommended.\n\n**Install**\n```shell\npython -m pip install jarvis-ironman\n```\n\n**Initiate**\n```python\nimport jarvis\n\n\nif __name__ == '__main__':\n jarvis.start()\n```\n\n## Prerequisites\n - **MacOS** <br> _Tested on **macOS High Sierra, Mojave, Catalina, Big Sur, Monterey and Ventura**_\n - `System Preferences` \u2192 `Security & Privacy` \u2192 `Privacy`\n - Click `+` sign and add the preferred `IDE` and `Terminal` in the following sections in left pane.\n - `Microphone` - **Required** to listen and respond.\n - `Accessibility` - **Required** to use key combinations for brightness and volume controls.\n - `Camera` - **[Optional]** Required only during face recognition/detection.\n - `Automation` - **Required** to control `System Events` and other apps like Outlook and Calendar.\n - `Files and Folders` **[OR]** `Full Disk Access` - **Required** for all `FileIO` operations.\n\n - **Linux** <br> _Tested on **Ubuntu 22.04 LTS**_\n - Store the host machine's password as the env var: `ROOT_PASSWORD`\n - Unlike macOS and Windows, `Ubuntu` does not have app specific permissions.\n\n - **Windows** <br> _Tested on **Windows 10**_\n - `Settings` \u2192 `Privacy`\n - `Microphone` - **Required** to listen and respond.\n - `Camera` - **[Optional]** Required only during face recognition/detection.\n - Unlike `macOS`, `Windows` pops a confirmation window to **Allow** or **Deny** access to files and folders.\n - Install [Anaconda][conda] or [Miniconda][miniconda], [VisualStudio C++ BuildTools][vcpp], and [Git][git-cli]\n - Make sure C++ build tools are installed completely and restart\n - Add anaconda/miniconda scripts location to `PATH` in Environment Variables\n\n## Enchiridion\nHandbook - [GitHub Wiki][wiki]\n\n## Coding Standards\nDocstring format: [`Google`][google-docs] <br>\nStyling conventions: [`PEP 8`][pep8] and [`isort`][isort]\n\n## [Release Notes][release-notes]\n**Requirement**\n```shell\npython -m pip install gitverse\n```\n\n**Usage**\n```shell\ngitverse-release reverse -f release_notes.rst -t 'Release Notes'\n```\n\n## Linting\n`pre-commit` will ensure linting, run pytest, generate runbook & release notes, and validate hyperlinks in ALL\nmarkdown files (including Wiki pages)\n\n**Requirement**\n```shell\npip install sphinx==5.1.1 pre-commit recommonmark\n```\n\n**Usage**\n```shell\npre-commit run --all-files\n```\n\n## Pypi Package\n[][pypi-repo]\n\n[https://pypi.org/project/jarvis-ironman/][pypi]\n\n## Runbook\n[][sphinx]\n\n[https://jarvis-docs.vigneshrao.com/][runbook]\n\n## License & copyright\n\n© Vignesh Rao\n\nLicensed under the [MIT License][license]\n\n[python]: https://python.org\n[venv]: https://docs.python.org/3/tutorial/venv.html\n[pycharm]: https://www.jetbrains.com/pycharm/\n[repo]: https://api.github.com/repos/thevickypedia/Jarvis\n[license]: https://github.com/thevickypedia/Jarvis/blob/master/LICENSE\n[pypi]: https://pypi.org/project/jarvis-ironman\n[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/\n[wiki]: https://github.com/thevickypedia/Jarvis/wiki\n[release-notes]: https://github.com/thevickypedia/Jarvis/blob/master/release_notes.rst\n[gha_pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment\n[gha_pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml\n[gha_md_valid]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown-validation.yml\n[webpage]: https://vigneshrao.com/\n[webpage_contact]: https://vigneshrao.com/contact\n[conda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/\n[miniconda]: https://docs.conda.io/en/latest/miniconda.html#windows-installers\n[vcpp]: https://visualstudio.microsoft.com/visual-cpp-build-tools/\n[git-cli]: https://git-scm.com/download/win/\n[google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings\n[pep8]: https://www.python.org/dev/peps/pep-0008/\n[isort]: https://pycqa.github.io/isort/\n[sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html\n[runbook]: https://jarvis-docs.vigneshrao.com/\n",
"bugtrack_url": null,
"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. ",
"summary": "Voice-Activated Natural Language UI",
"version": "4.4.2",
"project_urls": {
"API": "https://jarvis.vigneshrao.com",
"Bug Tracker": "https://github.com/thevickypedia/Jarvis/issues",
"Demo": "https://vigneshrao.com/Jarvis/Jarvis_Demo.mp4",
"Docs": "https://jarvis-docs.vigneshrao.com",
"Health": "https://jarvis-health.vigneshrao.com",
"Homepage": "https://github.com/thevickypedia/Jarvis",
"Release Notes": "https://github.com/thevickypedia/Jarvis/blob/master/release_notes.rst",
"Source": "https://github.com/thevickypedia/Jarvis"
},
"split_keywords": [
"python",
"home-automation",
"natural-language-processing",
"text-to-speech",
"speech-recognition",
"jarvis",
"hotword-detection",
"virtual-assistant"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3467bcb6026ae22b872afdb0d80af7f1b3c23fe7485a3edfe2ac7b7a167f6b1",
"md5": "e4e81b62ab659205ff4cd85bd7de3bf0",
"sha256": "9ef1c7ac440f86a2ade558c1d6fd0633bd6d9356fcd31325d0590dc418b5cad4"
},
"downloads": -1,
"filename": "jarvis_ironman-4.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4e81b62ab659205ff4cd85bd7de3bf0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3300856,
"upload_time": "2024-02-03T06:06:49",
"upload_time_iso_8601": "2024-02-03T06:06:49.282827Z",
"url": "https://files.pythonhosted.org/packages/c3/46/7bcb6026ae22b872afdb0d80af7f1b3c23fe7485a3edfe2ac7b7a167f6b1/jarvis_ironman-4.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-03 06:06:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thevickypedia",
"github_project": "Jarvis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jarvis-ironman"
}
