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 <https://github.com/adafruit/circuitpython>`_
* `MicroPython's regular expression library (re) <https://circuitpython.readthedocs.io/en/latest/docs/library/re.html>`_
You can find which Adafruit boards have the ``re`` library `here <https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html>`_.
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 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 <https://pypi.org/project/circuitpython-csv/>`_. 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
<https://github.com/tekktrik/Circuitpython_CircuitPython_CSV/blob/HEAD/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>`_.
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-csv",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,csv,data,files,embedded,micropython,circuitpython",
"author": "",
"author_email": "Alec Delaney <tekktrik@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8c/68/311014cd240f0f393d6f129580c4c3a057890db5aee21715f02ca1c9deb8/circuitpython-csv-1.1.5.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-csv/badge/?version=latest\n :target: https://circuitpython-csv.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/tekktrik/Circuitpython_CircuitPython_CSV/workflows/Build%20CI/badge.svg\n :target: https://github.com/tekktrik/Circuitpython_CircuitPython_CSV/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\n\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License: MIT\n\n\n.. image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg\n :target: https://github.com/tekktrik/CircuitPython_CSV\n :alt: Maintained: Yes\n\n\nCircuitPython helper library for working with CSV files\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `MicroPython's regular expression library (re) <https://circuitpython.readthedocs.io/en/latest/docs/library/re.html>`_\n\nYou can find which Adafruit boards have the ``re`` library `here <https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html>`_.\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 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 circuitpython-csv\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nInstalling from PyPI\n====================\n\n.. note::\n\n This library is provided on PyPI so that code developed for microcontrollers with this\n library will also run on computers like the Raspberry Pi. If you just need a package\n for working with CSV files on a computer or SBC only, consider using the Python standard\n library's ``csv`` module instead.\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-csv/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-csv\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-csv\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 .venv/bin/activate\n pip3 install circuitpython-csv\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import sdcardio\n import storage\n import circuitpython_csv as csv\n\n # Initialize SD card\n spi = board.SPI()\n sdcard = sdcardio.SDCard(spi, board.D10)\n vfs = storage.VfsFat(sdcard)\n storage.mount(vfs, \"/sd\")\n\n # Write the CSV file!\n with open(\"/sd/testwrite.csv\", mode=\"w\", encoding=\"utf-8\") as writablefile:\n csvwriter = csv.writer(writablefile)\n csvwriter.writerow([\"I\", \"love\", \"CircuitPython\", \"!\"])\n csvwriter.writerow([\"Spam\"] * 3)\n\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/tekktrik/Circuitpython_CircuitPython_CSV/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nDocumentation\n=============\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\nAttribution\n===========\n\nSome 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.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for working with CSV files",
"version": "1.1.5",
"split_keywords": [
"adafruit",
"csv",
"data",
"files",
"embedded",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cac0c34254293a9c4bb464298b39b5e88cc6aa9fa06c83fa93e8cfa33216b05a",
"md5": "a488ce9c3ff17ea59c4f873a75448d38",
"sha256": "b819e1a0fb46e4797b8741af347cb63818342076aaacf20c82aef059491d14aa"
},
"downloads": -1,
"filename": "circuitpython_csv-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a488ce9c3ff17ea59c4f873a75448d38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6734,
"upload_time": "2023-04-10T16:54:13",
"upload_time_iso_8601": "2023-04-10T16:54:13.325445Z",
"url": "https://files.pythonhosted.org/packages/ca/c0/c34254293a9c4bb464298b39b5e88cc6aa9fa06c83fa93e8cfa33216b05a/circuitpython_csv-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c68311014cd240f0f393d6f129580c4c3a057890db5aee21715f02ca1c9deb8",
"md5": "1153c79447766e492a03db495cbf2c83",
"sha256": "900e0daf722fab3b073144aba4982e77ac4494dabe52aec1f9d3f4ae5ec7f1ab"
},
"downloads": -1,
"filename": "circuitpython-csv-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "1153c79447766e492a03db495cbf2c83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33909,
"upload_time": "2023-04-10T16:54:14",
"upload_time_iso_8601": "2023-04-10T16:54:14.387280Z",
"url": "https://files.pythonhosted.org/packages/8c/68/311014cd240f0f393d6f129580c4c3a057890db5aee21715f02ca1c9deb8/circuitpython-csv-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-10 16:54:14",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "circuitpython-csv"
}
JSON