Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pyoa/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pyoa/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PYOA/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PYOA/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 'Choose Your Own Adventure' framework for PyPortal.
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Usage Example
=============
.. code-block:: python
import adafruit_sdcard
import storage
from adafruit_pyoa import PYOA_Graphics
import board
import digitalio
try:
sdcard = adafruit_sdcard.SDCard(board.SPI(), digitalio.DigitalInOut(board.SD_CS))
vfs = storage.VfsFat(sdcard)
storage.mount(vfs, "/sd")
print("SD card found") # no biggie
except OSError:
print("No SD card found") # no biggie
gfx = PYOA_Graphics()
gfx.load_game("/cyoa")
current_card = 0 # start with first card
while True:
print("Current card:", current_card)
current_card = gfx.display_card(current_card)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pyoa/en/latest/>`_.
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/adafruit/Adafruit_CircuitPython_PYOA/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-PYOA",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, pyoa, text, adventure, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/23/29/ef79d08d3bfef43bbfd1bad6a682df3b635ae7ecdb364a54a2d6545263b2/adafruit_circuitpython_pyoa-2.6.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pyoa/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pyoa/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_PYOA/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PYOA/actions/\n :alt: Build Status\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 'Choose Your Own Adventure' framework for PyPortal.\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import adafruit_sdcard\n import storage\n from adafruit_pyoa import PYOA_Graphics\n import board\n import digitalio\n\n try:\n sdcard = adafruit_sdcard.SDCard(board.SPI(), digitalio.DigitalInOut(board.SD_CS))\n vfs = storage.VfsFat(sdcard)\n storage.mount(vfs, \"/sd\")\n print(\"SD card found\") # no biggie\n except OSError:\n print(\"No SD card found\") # no biggie\n\n gfx = PYOA_Graphics()\n\n gfx.load_game(\"/cyoa\")\n current_card = 0 # start with first card\n\n while True:\n print(\"Current card:\", current_card)\n current_card = gfx.display_card(current_card)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pyoa/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_PYOA/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python your own Adventure - card & button game",
"version": "2.6.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_REPLACE"
},
"split_keywords": [
"adafruit",
" pyoa",
" text",
" adventure",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c4eea755c32dfba3ef353b5e005610cce8f525dc3e268853aac7cea8216ff69",
"md5": "64bc7fbfe883cddf9992e69e642f580f",
"sha256": "3c74f2d1a9eccbfbde350583844650b5adfaaee5666ce23dbc6d737841b9953c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_PYOA-2.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "64bc7fbfe883cddf9992e69e642f580f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8054,
"upload_time": "2024-10-07T22:34:48",
"upload_time_iso_8601": "2024-10-07T22:34:48.722703Z",
"url": "https://files.pythonhosted.org/packages/0c/4e/ea755c32dfba3ef353b5e005610cce8f525dc3e268853aac7cea8216ff69/adafruit_circuitpython_PYOA-2.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2329ef79d08d3bfef43bbfd1bad6a682df3b635ae7ecdb364a54a2d6545263b2",
"md5": "e53af6fdf8c53a5cf31aff71d34be8d9",
"sha256": "11269e7b714494a344edde029757eb83d736adcda5d30abf8e2915518f7e2118"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pyoa-2.6.2.tar.gz",
"has_sig": false,
"md5_digest": "e53af6fdf8c53a5cf31aff71d34be8d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7237722,
"upload_time": "2024-10-07T22:34:50",
"upload_time_iso_8601": "2024-10-07T22:34:50.503101Z",
"url": "https://files.pythonhosted.org/packages/23/29/ef79d08d3bfef43bbfd1bad6a682df3b635ae7ecdb364a54a2d6545263b2/adafruit_circuitpython_pyoa-2.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:34:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_REPLACE",
"github_not_found": true,
"lcname": "adafruit-circuitpython-pyoa"
}
JSON
