Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ducky/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ducky/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_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://docs.hak5.org/hak5-usb-rubber-ducky/>`_
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
=====================
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 .venv
source .venv/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 adafruit_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()
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ducky/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_Ducky/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ducky",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ducky,ducky,,rubber,duckyscript",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/be/3e/3a463469e211abb01acdce4b883a6eb7433d75f30e45ace8787e5b55a02c/adafruit-circuitpython-ducky-1.1.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ducky/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ducky/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Ducky/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Ducky/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\nCircuitPython library for running DuckyScript\n\nDuckyScript\n============\nYou can find the DuckyScript Documentation `here <https://docs.hak5.org/hak5-usb-rubber-ducky/>`_\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\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ducky/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ducky\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ducky\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 adafruit-circuitpython-ducky\n\n\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 adafruit_ducky\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nHere is an example of using the Ducky library.\nFirst you will need to import the libraries\n\n.. code-block:: python\n\n import time\n import usb_hid\n from adafruit_hid.keyboard import Keyboard\n from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS\n import ducky\n\nOnce this is done, define the keyboard layout and initialize the `Ducky` object.\n\n.. code-block:: python\n\n time.sleep(1) # Sleep for a bit to avoid a race condition on some systems\n keyboard = Keyboard(usb_hid.devices)\n keyboard_layout = KeyboardLayoutUS(keyboard) # We're in the US :)\n\n duck = ducky.Ducky('duckyscript.txt', keyboard, keyboard_layout)\n\nNow, set up a loop which will run a line of the script every time `loop` is called.\n\n.. code-block:: python\n\n result = True\n while result is not False:\n result = duck.loop()\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ducky/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_Ducky/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for running DuckyScript",
"version": "1.1.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Ducky.git"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ducky",
"ducky",
"",
"rubber",
"duckyscript"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd949b20e91223b0b51bbc25cc59acd054125a63cb7045278ebed9a1b0afed65",
"md5": "785727f77a19fba9b5a495a54bda8f9b",
"sha256": "ca4a83fe48fbeebab01ed5fcc0223406f9bbe088d403db7c0f2c08ccee630207"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ducky-1.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "785727f77a19fba9b5a495a54bda8f9b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5864,
"upload_time": "2023-12-09T17:44:36",
"upload_time_iso_8601": "2023-12-09T17:44:36.844967Z",
"url": "https://files.pythonhosted.org/packages/cd/94/9b20e91223b0b51bbc25cc59acd054125a63cb7045278ebed9a1b0afed65/adafruit_circuitpython_ducky-1.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be3e3a463469e211abb01acdce4b883a6eb7433d75f30e45ace8787e5b55a02c",
"md5": "e930ece869de7b923a163978d0392462",
"sha256": "dcc90821289bb0d5bc834ec6935bbcfbe543d800296131e02a1b661fdc626f45"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ducky-1.1.3.tar.gz",
"has_sig": false,
"md5_digest": "e930ece869de7b923a163978d0392462",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26749,
"upload_time": "2023-12-09T17:44:38",
"upload_time_iso_8601": "2023-12-09T17:44:38.558377Z",
"url": "https://files.pythonhosted.org/packages/be/3e/3a463469e211abb01acdce4b883a6eb7433d75f30e45ace8787e5b55a02c/adafruit-circuitpython-ducky-1.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:44:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Ducky",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ducky"
}
JSON
