Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tekktrik/circuitpython_csv

CircuitPython helper library for working with CSV files
https://github.com/tekktrik/circuitpython_csv

circuitpython-library

Last synced: about 24 hours ago
JSON representation

CircuitPython helper library for working with CSV files

Awesome Lists containing this project

README 

        
Introduction

============



.. image:: https://readthedocs.org/projects/circuitpython-csv/badge/?version=latest

    :target: https://circuitpython-csv.readthedocs.io/

    :alt: Documentation Status



.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord



.. image:: https://github.com/tekktrik/Circuitpython_CircuitPython_CSV/workflows/Build%20CI/badge.svg

    :target: https://github.com/tekktrik/Circuitpython_CircuitPython_CSV/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



.. image:: https://img.shields.io/badge/License-MIT-yellow.svg

    :target: https://opensource.org/licenses/MIT

    :alt: License: MIT



.. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg

    :target: https://github.com/tekktrik/CircuitPython_CSV

    :alt: Maintained: Yes



CircuitPython helper library for working with CSV files



Dependencies

=============

This driver depends on:



* `Adafruit CircuitPython `_

* `MicroPython's regular expression library (re) `_



You can find which Adafruit boards have the ``re`` library `here `_.



Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.



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 circuitpython-csv



Or the following command to update an existing version:



.. code-block:: shell



    circup update



Installing from PyPI

====================



.. note::



    This library is provided on PyPI so that code developed for microcontrollers with this

    library will also run on computers like the Raspberry Pi.  If you just need a package

    for working with CSV files on a computer or SBC only, consider using the Python standard

    library's ``csv`` module instead.



On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. To install for current user:



.. code-block:: shell



    pip3 install circuitpython-csv



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



.. code-block:: shell



    sudo pip3 install circuitpython-csv



To install in a virtual environment in your current project:



.. code-block:: shell



    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .venv/bin/activate

    pip3 install circuitpython-csv



Usage Example

=============



.. code-block:: python



    import board

    import sdcardio

    import storage

    import circuitpython_csv as csv



    # Initialize SD card

    spi = board.SPI()

    sdcard = sdcardio.SDCard(spi, board.D10)

    vfs = storage.VfsFat(sdcard)

    storage.mount(vfs, "/sd")



    # Write the CSV file!

    with open("/sd/testwrite.csv", mode="w", encoding="utf-8") as writablefile:

        csvwriter = csv.writer(writablefile)

        csvwriter.writerow(["I", "love", "CircuitPython", "!"])

        csvwriter.writerow(["Spam"] * 3)



Contributing

============



Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.



Documentation

=============



For information on building library documentation, please check out

`this guide `_.



Attribution

===========



Some code contained here is ported from CPython, dual licensed by the Python Software Foundation under the PSF License verion 2 and the Zero-Clause BSD license.