Skip to main content

Tools to improve Google Colab experience for screen reader users

Project description

colab-a11y-util

This library provides the following functions in Google Colab

  • Notification by sound at the time of cell execution
    • One beep sound when executed
    • Two beep sounds when normal completion
    • Two buzzer sounds when abnormal completion
  • Sound notification of progress bar by tqdm
  • Simple audio output function that can be used instead of print

See the following example.

Open In Colab

For contributer

Update PyPI

$ nosetests -vs
$ pip install twine # if necessary
$ cat ~/.pypirc  # if necessary
[distutils]
index-servers = pypi

[pypi]
repository: https://upload.pypi.org/legacy/
username: YOUR_USERNAME
password: YOUR_PASSWORD
$ rm -rf colab_a11y_utils.egg-info dist # if necessary
$ python setup.py sdist
$ twine upload --repository pypi dist/*
$ pip --no-cache-dir install --upgrade colab-a11y-utils

https://pypi.org/project/colab-a11y-utils/

Contributing

  • Fork the repository on Github
  • Create a named feature branch (like add_component_x)
  • Write your change
  • Write tests for your change (if applicable)
  • Run the tests, ensuring they all pass
  • Submit a Pull Request using Github

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

colab-a11y-utils-0.0.4.tar.gz (3.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page