Introduction
============
.. image:: https://readthedocs.org/projects/adafruitcircuitpythonfloppy/badge/?version=latest
:target: https://docs.circuitpython.org/projects/floppy/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_floppy/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_floppy/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
Interface with archaic spinning rust
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit Ticks <https://github.com/adafruit/adafruit_circuitpython_ticks>`_
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 adafruit_floppy
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See the `Examples page <examples.html>`_ for a full example. This example shows how to initialize a floppy and seek to track 1, but it omits the pin arguments to the Floppy constructor for brevity:
.. code-block:: python
import board
import adafruit_floppy
floppy = adafruit_floppy.MFMFloppy(...)
floppy.selected = True
floppy.spin = True
floppy.track = 1
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_floppy/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>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-floppy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, floppy, drive, storage, hardware, micropythoncircuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/3c/a5/fc7b2c3e030f8426e8759880c9fcfd20bbce9957e22b23c33d8d0bb26b8e/adafruit_circuitpython_floppy-2.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruitcircuitpythonfloppy/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/floppy/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_floppy/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_floppy/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\nInterface with archaic spinning rust\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit Ticks <https://github.com/adafruit/adafruit_circuitpython_ticks>`_\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\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_floppy\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee the `Examples page <examples.html>`_ for a full example. This example shows how to initialize a floppy and seek to track 1, but it omits the pin arguments to the Floppy constructor for brevity:\n\n.. code-block:: python\n\n import board\n import adafruit_floppy\n\n floppy = adafruit_floppy.MFMFloppy(...)\n\n floppy.selected = True\n floppy.spin = True\n floppy.track = 1\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_floppy/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nDocumentation\n=============\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Access floppy drives from CircuitPython",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Floppy"
},
"split_keywords": [
"adafruit",
" floppy",
" drive",
" storage",
" hardware",
" micropythoncircuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "df75072f573b697d74595983a07839d16c3b3e3cf635a87c941bef4493dd7e74",
"md5": "afdde742279ae5c06963f67cc42565e7",
"sha256": "da7c9390831f6176b4c6fd2f5d1e293474ba292a36f0b85d3b787d2131021cc8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_floppy-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afdde742279ae5c06963f67cc42565e7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6766,
"upload_time": "2024-04-22T16:48:56",
"upload_time_iso_8601": "2024-04-22T16:48:56.423033Z",
"url": "https://files.pythonhosted.org/packages/df/75/072f573b697d74595983a07839d16c3b3e3cf635a87c941bef4493dd7e74/adafruit_circuitpython_floppy-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ca5fc7b2c3e030f8426e8759880c9fcfd20bbce9957e22b23c33d8d0bb26b8e",
"md5": "d7c1037b9a296f8092e383f2ee80420e",
"sha256": "8073f9c5c954a80d7df56526a98281b1d80d8cde55aadbb61224171d090fe549"
},
"downloads": -1,
"filename": "adafruit_circuitpython_floppy-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d7c1037b9a296f8092e383f2ee80420e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28820,
"upload_time": "2024-04-22T16:48:57",
"upload_time_iso_8601": "2024-04-22T16:48:57.475332Z",
"url": "https://files.pythonhosted.org/packages/3c/a5/fc7b2c3e030f8426e8759880c9fcfd20bbce9957e22b23c33d8d0bb26b8e/adafruit_circuitpython_floppy-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 16:48:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Floppy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-floppy"
}
JSON
