{ "info": { "author": "Matt Clarkson", "author_email": "YOUR-EMAIL@ucl.ac.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Intended Audience :: Healthcare Industry", "Intended Audience :: Information Technology", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering :: Information Analysis", "Topic :: Scientific/Engineering :: Medical Science Apps." ], "description": "scikit-surgeryspeech\n===============================\n\n.. image:: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/raw/master/project-icon.png\n :height: 128px\n :width: 128px\n :target: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech\n :alt: Logo\n\n.. image:: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/badges/master/build.svg\n :target: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/pipelines\n :alt: GitLab-CI test status\n\n.. image:: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/badges/master/coverage.svg\n :target: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/commits/master\n :alt: Test coverage\n\n\n\nAuthor: Kim-Celine Kahl\n\nscikit-surgeryspeech is part of the `SNAPPY`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.\n\nscikit-surgeryspeech supports Python 3.6.\n\nscikit-surgeryspeech is a project which runs the `Python Speech Recognition API`_ in the background listening\nfor a specific command. After saying the keyword you can say different commands, which get\nconverted to QT Signals.\n\nThe speech recognition is done by the `Google Cloud API`_, you have to get the credentials to use it or change the recognition service.\n\nKeyword detection is done by the `Porcupine API`_, you have to set different paths in your environment variables to get it running, described below.\n\nPlease explore the project structure, and implement your own functionality.\n\nExample usage\n-------------\n\nTo run an example, just start\n\n::\n\n sksurgeryspeech.py\n\nMake sure Google Cloud API is set up correctly as described in the section below.\n\nAlso you have to set all the Parameters for the Porcupine keyword detection, also described below.\n\nYou can then say the keyword depending on the Porcupine keyword file you chose and afterwards a command. The command \"quit\" exits the application.\n\nNote: each time you have already entered a command, you need to say the keyword again to trigger the listening to commands.\n\nDeveloping\n----------\n\nCloning\n^^^^^^^\n\nYou can clone the repository using the following command:\n\n::\n\n git clone https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech\n\nIf you have problems running the application, you might need to install portaudio\n\n::\n\n brew install portaudio\n\nSet up the Porcupine keyword detection\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you are running the keyword example, you need to clone the Porcupine API\n\n::\n\n git clone https://github.com/Picovoice/Porcupine.git\n\nThen, you have to set the following environment variables (here the paths are just relative to the Porcupine folder, set the full paths) :\n\n::\n\n PYTHONPATH=Porcupine\\binding\\python\n PORCUPINE_DYNAMIC_LIBRARY=Porcupine\\lib\\\\\\\n PORCUPINE_PARAMS=Porcupine\\lib\\common\\porcupine_params.pv\n PORCUPINE_KEYWORD=Porcupine\\resources\\keyword_files\\\\\n\nYou can also `generate your own keyword files`_\n\nIf you are using the speech recognition service within your own application, you have to start a background thread which calls the method to listen to the keyword over and over again.\n\nYou can find an example how to create such a thread in the sksurgeryspech_demo.py\n\nUse the Google Cloud speech recognition service\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n.. _`Google Cloud API is set up correctly`:\n\nTo use the Google Cloud speech recognition service, you need to `get the credentials`_ first. After signing up, you\nshould get a json file with your credentials. Download this file and set the environment variable\n\n::\n\n GOOGLE_APPLICATION_CREDENTIALS\n\nTo the path of your json file. You should then be able to run the application.\n\n\nChange speech recognition service\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nTo change the speech recognition service if you don't want to use the Google Cloud API, just change the command\n\n::\n\n words = recognizer.recognize_google_cloud(audio, credentials_json=self.credentials)\n\n(file \"voice_recognition_service.py\", method \"listen_to_command(self)\")\nto the recognition service of your choice. Currently available services are:\n\n::\n\n recognizer.recognize_sphinx(audio)\n recognizer.recognize_google(audio)\n recognizer.recognize_google_cloud(audio, credentials_json=GOOGLE_CLOUD_SPEECH_CREDENTIALS)\n recognizer.recognize_wit(audio, key=WIT_AI_KEY)\n recognizer.recognize_bing(audio, key=BING_KEY)\n recognizer.recognize_azure(audio, key=AZURE_SPEECH_KEY)\n recognizer.recognize_houndify(audio, client_id=HOUNDIFY_CLIENT_ID, client_key=HOUNDIFY_CLIENT_KEY)\n recognizer.recognize_ibm(audio, username=IBM_USERNAME, password=IBM_PASSWORD)\n\nPython development\n^^^^^^^^^^^^^^^^^^\n\nThis project uses tox. Start with a clean python environment, then do:\n\n::\n\n pip install tox\n tox\n\nand the commands that are run can be found in tox.ini.\n\n\nInstalling\n----------\n\nYou can pip install directly from the repository as follows:\n\n::\n\n pip install git+https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech\n\n\n\nContributing\n^^^^^^^^^^^^\n\nPlease see the `contributing guidelines`_.\n\n\nUseful links\n^^^^^^^^^^^^\n\n* `Source code repository`_\n\n\nLicensing and copyright\n-----------------------\n\nCopyright 2019 University College London.\nscikit-surgeryspeech is released under the BSD-3 license. Please see the `license file`_ for details.\n\n\nAcknowledgements\n----------------\n\nSupported by `Wellcome`_ and `EPSRC`_.\n\n\n.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss\n.. _`source code repository`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech\n.. _`SNAPPY`: https://weisslab.cs.ucl.ac.uk/WEISS/PlatformManagement/SNAPPY/wikis/home\n.. _`University College London (UCL)`: http://www.ucl.ac.uk/\n.. _`Wellcome`: https://wellcome.ac.uk/\n.. _`EPSRC`: https://www.epsrc.ac.uk/\n.. _`contributing guidelines`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech/blob/master/LICENSE\n.. _`Python Speech Recognition API`: https://pypi.org/project/SpeechRecognition/\n.. _`Google Cloud API`: https://cloud.google.com/speech-to-text/\n.. _`Porcupine API`: https://github.com/Picovoice/Porcupine\n.. _`generate your own keyword files`: https://github.com/Picovoice/Porcupine/tree/master/tools/optimizer\n.. _`get the credentials`: https://console.cloud.google.com/freetrial/signup/tos?_ga=2.263649484.-1718611742.1562839990\n\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech", "keywords": "medical imaging", "license": "BSD-3 license", "maintainer": "", "maintainer_email": "", "name": "scikit-surgeryspeech", "package_url": "https://pypi.org/project/scikit-surgeryspeech/", "platform": "", "project_url": "https://pypi.org/project/scikit-surgeryspeech/", "project_urls": { "Homepage": "https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/SNAPPY/scikit-surgeryspeech" }, "release_url": "https://pypi.org/project/scikit-surgeryspeech/0.0.8/", "requires_dist": [ "six (>=1.10)", "numpy (>=1.11)" ], "requires_python": "", "summary": "Interface to speech services for image-guided surgery.", "version": "0.0.8" }, "last_serial": 5863703, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "625ccf898795baaa22d0139ba58858b8", "sha256": "84f4cf35b5938fc6bbda10fa8b9a1a2f21734b16f0464531f6c8756d2186ea35" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "625ccf898795baaa22d0139ba58858b8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 14742, "upload_time": "2019-07-19T14:20:24", "url": "https://files.pythonhosted.org/packages/2c/1e/e03bd8ef8539f671097ffd4a9ce6e3232c2d14f83f5996c5515bfe26ac24/scikit_surgeryspeech-0.0.1-py2.py3-none-any.whl" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "25b6f6608319eabeb730d0c3a0afae0d", "sha256": "966ad26d365c320deace7d4acfe4080fb48b6867d5e143473285b9b81aa615de" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "25b6f6608319eabeb730d0c3a0afae0d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15182, "upload_time": "2019-07-25T14:29:04", "url": "https://files.pythonhosted.org/packages/13/ae/c4eb5f50374ffab2110096188fda39c51e818545e102cc7a3ad180f7baaf/scikit_surgeryspeech-0.0.2-py2.py3-none-any.whl" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "ecde6f78b75ae1de5d458143e09056db", "sha256": "4b98a816be5e65276e376ecdf2475ff724d88e752b520f54de9c0a8baed99ddd" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ecde6f78b75ae1de5d458143e09056db", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15632, "upload_time": "2019-07-29T13:22:20", "url": "https://files.pythonhosted.org/packages/9e/f1/d08ab3f3799a9990e371f0b34395eee08171316bd730c95ec8136d93a1ed/scikit_surgeryspeech-0.0.3-py2.py3-none-any.whl" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "5112edbc0492f790491d89471f2a0439", "sha256": "7bfd935dcd25683e64c8db9f4f34987a3be964c47d5c1c3eafcf25716fbf46a9" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5112edbc0492f790491d89471f2a0439", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15770, "upload_time": "2019-07-30T09:37:49", "url": "https://files.pythonhosted.org/packages/64/06/7303dbdb8311a3b98d4e9f23c2110a387e8c8ca797bada3ddc1d017c4234/scikit_surgeryspeech-0.0.4-py2.py3-none-any.whl" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "42775ca1c2f57d60cda00ecdcac84d55", "sha256": "af2fb40d3963c629d86332069c2952a9e7bf265ffe952f16cf494902549bf1b9" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "42775ca1c2f57d60cda00ecdcac84d55", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15772, "upload_time": "2019-07-31T09:57:45", "url": "https://files.pythonhosted.org/packages/97/62/5d8aae9071600d3faff63a59f15d917363a7cadc71d1565681461168bde8/scikit_surgeryspeech-0.0.5-py2.py3-none-any.whl" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "07d9b3d2a01d8506d66d7fd6822c1416", "sha256": "36c8cfcbe755939c2bcd6e89e343ef683fa71167f272c11e2b932909cf88b146" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "07d9b3d2a01d8506d66d7fd6822c1416", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15968, "upload_time": "2019-08-05T09:49:13", "url": "https://files.pythonhosted.org/packages/29/e7/911bc346cd413a2495419bc01edb0e37961d5a4db0beb44ed31132d2e9e3/scikit_surgeryspeech-0.0.6-py2.py3-none-any.whl" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "9e40fdf013b2f93055ea82cba7bcaeaa", "sha256": "12e660cd52ecb0efc50599246f3573ec2fc049f41bb062aceec75f3f566827ac" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9e40fdf013b2f93055ea82cba7bcaeaa", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16120, "upload_time": "2019-09-18T08:43:21", "url": "https://files.pythonhosted.org/packages/f1/cf/8b5de7c55a8117c548bbddcfe6bb8c7547f80b9fe7d43db22e96c5fb0bb4/scikit_surgeryspeech-0.0.7-py2.py3-none-any.whl" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "e8f69c57cdd12ea8630f129eb9f113c4", "sha256": "6efe780a072d0e8c6cb392955eeb35987ca4cceb105608763c9b3bbe5a84bd1b" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e8f69c57cdd12ea8630f129eb9f113c4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16147, "upload_time": "2019-09-20T19:01:07", "url": "https://files.pythonhosted.org/packages/39/e0/8e5f87d97e0431aab79e547b897ccc559efbcee9008bd74e3adc65e29045/scikit_surgeryspeech-0.0.8-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e8f69c57cdd12ea8630f129eb9f113c4", "sha256": "6efe780a072d0e8c6cb392955eeb35987ca4cceb105608763c9b3bbe5a84bd1b" }, "downloads": -1, "filename": "scikit_surgeryspeech-0.0.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e8f69c57cdd12ea8630f129eb9f113c4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16147, "upload_time": "2019-09-20T19:01:07", "url": "https://files.pythonhosted.org/packages/39/e0/8e5f87d97e0431aab79e547b897ccc559efbcee9008bd74e3adc65e29045/scikit_surgeryspeech-0.0.8-py2.py3-none-any.whl" } ] }