Metadata-Version: 2.1
Name: adafruit-circuitpython-ducky
Version: 1.0.0
Summary: CircuitPython library for running DuckyScript
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_Ducky.git
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-ducky/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/ducky/en/latest/
            :alt: Documentation Status
        
        
        .. image:: https://img.shields.io/discord/327254708534116352.svg
            :target: https://adafru.it/discord
            :alt: Discord
        
        
        .. image:: https://github.com/adafruit/Adafruit_CircuitPython_Ducky/workflows/Build%20CI/badge.svg
            :target: https://github.com/adafruit/Adafruit_CircuitPython_Ducky/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
        
        CircuitPython library for running DuckyScript
        
        DuckyScript
        ============
        You can find the DuckyScript Documentation `here <https://github.com/hak5darren/USB-Rubber-Ducky/wiki/Duckyscript>`_
        
        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 from PyPI
        =====================
        .. note:: This library is not available on PyPI yet. Install documentation is included
           as a standard element. Stay tuned for PyPI availability!
        
        On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
        PyPI <https://pypi.org/project/adafruit-circuitpython-ducky/>`_.
        To install for current user:
        
        .. code-block:: shell
        
            pip3 install adafruit-circuitpython-ducky
        
        To install system-wide (this may be required in some cases):
        
        .. code-block:: shell
        
            sudo pip3 install adafruit-circuitpython-ducky
        
        To install in a virtual environment in your current project:
        
        .. code-block:: shell
        
            mkdir project-name && cd project-name
            python3 -m venv .env
            source .env/bin/activate
            pip3 install adafruit-circuitpython-ducky
        
        
        
        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 ducky
        
        Or the following command to update an existing version:
        
        .. code-block:: shell
        
            circup update
        
        Usage Example
        =============
        
        Here is an example of using the Ducky library.
        First you will need to import the libraries
        
        .. code-block:: python
        
            import time
            import usb_hid
            from adafruit_hid.keyboard import Keyboard
            from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
            import ducky
        
        Once this is done, define the keyboard layout and initialize the `Ducky` object.
        
        .. code-block:: python
        
            time.sleep(1)  # Sleep for a bit to avoid a race condition on some systems
            keyboard = Keyboard(usb_hid.devices)
            keyboard_layout = KeyboardLayoutUS(keyboard)  # We're in the US :)
        
            duck = ducky.Ducky('duckyscript.txt', keyboard, keyboard_layout)
        
        Now, set up a loop which will run a line of the script every time `loop` is called.
        
        .. code-block:: python
        
            result = True
            while result is not False:
                result = duck.loop()
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_Ducky/blob/HEAD/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        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>`_.
        
Keywords: adafruit blinka circuitpython micropython ducky ducky,rubber duckyscript
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
