Skip to main content

Easy interface to store and retrieve objects persisted via NVM

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

Easy interface to store and retrieve objects persisted via NVM

Dependencies

This driver depends on:

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 from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install foamyguy-circuitpython-nvm-helper

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

sudo pip3 install foamyguy-circuitpython-nvm-helper

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install foamyguy-circuitpython-nvm-helper

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 nvm_helper

Or the following command to update an existing version:

circup update

Usage Example

import foamyguy_nvm_helper as nvm_helper

nvm_helper.save_data(
    {"name": "nvm_helper", "num": 92, "float": 3.14}, test_run=False, verbose=True
)
read_data = nvm_helper.read_data()
print("read data is:")
print(read_data)

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foamyguy-circuitpython-nvm-helper-1.0.2.tar.gz (28.5 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page