adafruit-circuitpython-PYOA


Nameadafruit-circuitpython-PYOA JSON
Version 2.6.1 PyPI version JSON
download
home_page
SummaryPython your own Adventure - card & button game
upload_time2023-12-09 17:46:50
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit pyoa text adventure hardware micropython circuitpython
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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": "",
    "name": "adafruit-circuitpython-PYOA",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,pyoa,text,adventure,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/a3/08/79f8b4374fa4a1a3fb88cd54e12bff3d71d38c426b09bb1d5d0ee1271d0c/adafruit-circuitpython-PYOA-2.6.1.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.1",
    "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": "1ea05c0d472a804df2259893d11857e7f8ed4690fa607dbb951971fdb27e5a2e",
                "md5": "93fdd0d283793a83dad4a85d966f05db",
                "sha256": "6a26b16289ba099d4727a0afa1a37a4463100c70a7856b7154f69a4030abaaa6"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_PYOA-2.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93fdd0d283793a83dad4a85d966f05db",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8053,
            "upload_time": "2023-12-09T17:46:48",
            "upload_time_iso_8601": "2023-12-09T17:46:48.762211Z",
            "url": "https://files.pythonhosted.org/packages/1e/a0/5c0d472a804df2259893d11857e7f8ed4690fa607dbb951971fdb27e5a2e/adafruit_circuitpython_PYOA-2.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a30879f8b4374fa4a1a3fb88cd54e12bff3d71d38c426b09bb1d5d0ee1271d0c",
                "md5": "8549ef13bc73998e9e90da7a8398b253",
                "sha256": "039a1d1cc5a1d77d69857fc1a142f8e7c95d43103466cde53e46fe699709fbab"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-PYOA-2.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8549ef13bc73998e9e90da7a8398b253",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7237780,
            "upload_time": "2023-12-09T17:46:50",
            "upload_time_iso_8601": "2023-12-09T17:46:50.013735Z",
            "url": "https://files.pythonhosted.org/packages/a3/08/79f8b4374fa4a1a3fb88cd54e12bff3d71d38c426b09bb1d5d0ee1271d0c/adafruit-circuitpython-PYOA-2.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:46: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"
}
        
Elapsed time: 0.16279s