Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-functools/badge/?version=latest
:target: https://circuitpython-functools.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_functools/workflows/Build%20CI/badge.svg
:target: https://github.com/tekktrik/CircuitPython_functools/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
A CircuitPython implementation of CPython's functools library
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
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 functools
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 functiols on a computer or SBC only, consider using the Python standard
library's ``functools`` module instead.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-functools/>`_. To install for current user:
.. code-block:: shell
pip3 install circuitpython-functools
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-functools
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-functools
Usage Example
=============
See examples in the `examples/` folder
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-functools.readthedocs.io/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/tekktrik/CircuitPython_functools/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-functools",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,functools,cache,functions,decorators",
"author": "",
"author_email": "Alec Delaney <tekktrik@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/48/c1/bebf35c86e200c6d41a0cc21fb0e6ed3f5846981ccc21a43f68f9b013cfe/circuitpython-functools-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-functools/badge/?version=latest\n :target: https://circuitpython-functools.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_functools/workflows/Build%20CI/badge.svg\n :target: https://github.com/tekktrik/CircuitPython_functools/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\nA CircuitPython implementation of CPython's functools library\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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 functools\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 functiols on a computer or SBC only, consider using the Python standard\n library's ``functools`` 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-functools/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-functools\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-functools\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-functools\n\nUsage Example\n=============\n\nSee examples in the `examples/` folder\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-functools.readthedocs.io/>`_.\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\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/tekktrik/CircuitPython_functools/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CircuitPython implementation of CPython's functools library",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/tekktrik/CircuitPython_functools"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"functools",
"cache",
"functions",
"decorators"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbd030ff0466b054e56282c7e8647da1eb15acd27d54788ce52059bdb108636d",
"md5": "6f11b6a76279ed4f5076c15744b9daf6",
"sha256": "737aa04c5964f386c12e15dec9a86d0afe76384c8de95112a6d0cd88b8c7f83b"
},
"downloads": -1,
"filename": "circuitpython_functools-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f11b6a76279ed4f5076c15744b9daf6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4800,
"upload_time": "2024-01-15T16:28:58",
"upload_time_iso_8601": "2024-01-15T16:28:58.355015Z",
"url": "https://files.pythonhosted.org/packages/bb/d0/30ff0466b054e56282c7e8647da1eb15acd27d54788ce52059bdb108636d/circuitpython_functools-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "48c1bebf35c86e200c6d41a0cc21fb0e6ed3f5846981ccc21a43f68f9b013cfe",
"md5": "09dea631637492cf644dc0f0ab20ddea",
"sha256": "e397fa4045a66b3fa6162396080c2ac7cc5ca5fa99f1478c350662dac7a46391"
},
"downloads": -1,
"filename": "circuitpython-functools-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "09dea631637492cf644dc0f0ab20ddea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29249,
"upload_time": "2024-01-15T16:29:13",
"upload_time_iso_8601": "2024-01-15T16:29:13.387361Z",
"url": "https://files.pythonhosted.org/packages/48/c1/bebf35c86e200c6d41a0cc21fb0e6ed3f5846981ccc21a43f68f9b013cfe/circuitpython-functools-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 16:29:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tekktrik",
"github_project": "CircuitPython_functools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-functools"
}
JSON
