tekktrik / circuitpython_csv

CircuitPython helper library for working with CSV files

Introduction

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:

pip3 install circup

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

circup install circuitpython-csv

Or the following command to update an existing version:

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:

pip3 install circuitpython-csv

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

sudo pip3 install circuitpython-csv

To install in a virtual environment in your current project:

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

Usage Example

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.

circuitpython_csv's Issues

Implement duck typing via Protocol

Once the CI is updated to use Python 3.8+, Protocol should be used for duck typing SupportsStringCasting

Update circup installation instructions

Installation instruction regarding circup need to be fixed!

Update infrastructure

• Update pre-commit hooks
• Switch to ruff
• Remove .pylintrc