adafruit-circuitpython-wave


Nameadafruit-circuitpython-wave JSON
Version 0.0.4 PyPI version JSON
download
home_pageNone
SummaryRead and write standard WAV-format files
upload_time2024-10-07 22:35:23
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython wave
VCS
bugtrack_url
requirements Adafruit-Blinka
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/circuitpython-wave/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/wave/en/latest/
    :alt: Documentation Status


.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/adafruit/Adafruit_CircuitPython_wave/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_wave/actions
    :alt: Build Status


.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

Read and write standard WAV-format files


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-wave/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-wave

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-wave

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install adafruit-circuitpython-wave

Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install adafruit_wave

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import adafruit_wave

    with adafruit_wave.open("sample.wav") as w:
        print(w.getsampwidth())
        print(w.getnchannels())
        print(list(memoryview(w.readframes(100)).cast("h")))

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/wave/en/latest/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_wave/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-wave",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, wave",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/91/49/17d24e7be275a5c08a586de14b89bd367e296411776b08b0ab84aeb85714/adafruit_circuitpython_wave-0.0.4.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-wave/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/wave/en/latest/\n    :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_wave/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_wave/actions\n    :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nRead and write standard WAV-format files\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-wave/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-wave\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-wave\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .env/bin/activate\n    pip3 install adafruit-circuitpython-wave\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n    pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n    circup install adafruit_wave\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n    circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import adafruit_wave\n\n    with adafruit_wave.open(\"sample.wav\") as w:\n        print(w.getsampwidth())\n        print(w.getnchannels())\n        print(list(memoryview(w.readframes(100)).cast(\"h\")))\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/wave/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_wave/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Read and write standard WAV-format files",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_wave"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " wave"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8de94dd5163e540912e3ecf1c94d7e62fe1afdc3f1cfba4b59293a1d8ac31192",
                "md5": "f7a41df84a4d4a8c5b7fb619e9ed70fe",
                "sha256": "ec9036c63633c3553cdb12177737d747fb3dfca49267a14a495c9908848f6cdb"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_wave-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f7a41df84a4d4a8c5b7fb619e9ed70fe",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7568,
            "upload_time": "2024-10-07T22:35:22",
            "upload_time_iso_8601": "2024-10-07T22:35:22.172324Z",
            "url": "https://files.pythonhosted.org/packages/8d/e9/4dd5163e540912e3ecf1c94d7e62fe1afdc3f1cfba4b59293a1d8ac31192/adafruit_circuitpython_wave-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "914917d24e7be275a5c08a586de14b89bd367e296411776b08b0ab84aeb85714",
                "md5": "eb748d1eac3b4843e7c5f65ebef7eac1",
                "sha256": "28105c8d9b18330042bc6fb123da1e46bbc10fe6e2c8dae8883ea42888c54c01"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_wave-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "eb748d1eac3b4843e7c5f65ebef7eac1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 33567,
            "upload_time": "2024-10-07T22:35:23",
            "upload_time_iso_8601": "2024-10-07T22:35:23.912878Z",
            "url": "https://files.pythonhosted.org/packages/91/49/17d24e7be275a5c08a586de14b89bd367e296411776b08b0ab84aeb85714/adafruit_circuitpython_wave-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:35:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_wave",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-wave"
}
        
Elapsed time: 0.38867s