Skip to main content

Pass arguments to code files by writing them to a file before launching.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Pass arguments to code files by writing them to a file before launching.

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 adafruit-circuitpython-argv-file

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

sudo pip3 install adafruit-circuitpython-argv-file

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-argv-file

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 adafruit_argv_file

Or the following command to update an existing version:

circup update

Usage Example

import supervisor

from adafruit_argv_file import write_argv

write_argv("argv_file_otherfile.py", [42, "CircuitPython is Cool", None, [1, 2, 3]])

print("Launching: argv_file_otherfile.py")
supervisor.set_next_code_file("argv_file_otherfile.py")
supervisor.reload()

argv_file_otherfile.py

from adafruit_argv_file import read_argv

args = read_argv(__file__)
print(args)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

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

adafruit_circuitpython_argv_file-1.0.3.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_argv_file-1.0.3.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_argv_file-1.0.3.tar.gz
Algorithm Hash digest
SHA256 f55b8b393d1194411a3bd39bdd384d88f9899436ff2ce5d1cc36e4e730ae2f0a
MD5 2bda774e09cfe096f44a0d222ec3e544
BLAKE2b-256 d12db728c9c1fcb6a71de142fe6d99f8b33a865ad23c0a896a6c97f2fa562060

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_argv_file-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_argv_file-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7c3593bfe0dd757661ecb98d8c22af68974c2c6c9158ef1b72ac170c20f99509
MD5 31b4a32867481a70cb3151381b96a1cb
BLAKE2b-256 80a0971398eaac5d4a1f6d4d619ac42c6e13c031da6eaf93cad267a0bd587b3e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page