Metadata-Version: 2.1
Name: adafruit-circuitpython-sd
Version: 3.3.0
Summary: CircuitPython library for SD cards.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_SD
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: 
        Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-sd/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/sd/en/latest/
            :alt: Documentation Status
        
        .. image :: https://img.shields.io/discord/327254708534116352.svg
            :target: https://adafru.it/discord
            :alt: Discord
        
        .. image:: https://github.com/adafruit/Adafruit_CircuitPython_SD/workflows/Build%20CI/badge.svg
            :target: https://github.com/adafruit/Adafruit_CircuitPython_SD/actions/
            :alt: Build Status
        
        CircuitPython driver for SD cards. This implements the basic reading and writing
        block functionality needed to mount an SD card using `storage.VfsFat`.
        
        Dependencies
        =============
        This driver depends on:
        
        * `Adafruit CircuitPython 2.0.0+ <https://github.com/adafruit/circuitpython>`_
        * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
        
        Please ensure all dependencies are available on the CircuitPython filesystem.
        This is easily achieved by downloading
        `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
        
        Usage Example
        =============
        
        Mounting a filesystem on an SD card so that its available through the normal Python
        ways is easy.
        
        Below is an example for the Feather M0 Adalogger. Most of this will stay the same
        across different boards with the exception of the pins for the SPI and chip
        select (cs) connections.
        
        .. code-block:: python
        
            import adafruit_sdcard
            import busio
            import digitalio
            import board
            import storage
        
            # Connect to the card and mount the filesystem.
            spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
            cs = digitalio.DigitalInOut(board.SD_CS)
            sdcard = adafruit_sdcard.SDCard(spi, cs)
            vfs = storage.VfsFat(sdcard)
            storage.mount(vfs, "/sd")
        
            # Use the filesystem as normal.
            with open("/sd/test.txt", "w") as f:
                f.write("Hello world\n")
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_sdcard/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        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>`_.
        
Keywords: adafruit sdcard sd card mount storage featherwing adaloggerbreakout hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
