fresh cookiecutter

Author: brentru

.travis.yml

@@ -42,7 +42,7 @@ install:
   - pip install --force-reinstall pylint==1.9.2
 
 script:
-  - pylint adafruit_cursor.py
+  - pylint adafruit_cursorcontrol.py
   - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursor --library_location .
+  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursorcontrol --library_location .
   - cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

@@ -1,20 +1,20 @@
 Introduction
 ============
 
-.. image:: https://readthedocs.org/projects/adafruit-circuitpython-cursor/badge/?version=latest
-    :target: https://circuitpython.readthedocs.io/projects/cursor/en/latest/
+.. image:: https://readthedocs.org/projects/adafruit-circuitpython-cursorcontrol/badge/?version=latest
+    :target: https://circuitpython.readthedocs.io/projects/cursorcontrol/en/latest/
     :alt: Documentation Status
 
 .. image:: https://img.shields.io/discord/327254708534116352.svg
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
-.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor.svg?branch=master
-    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Cursor
+.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_CursorControl.svg?branch=master
+    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_CursorControl
     :alt: Build Status
 
-Mouse cursor for interaction with CircuitPython UI elements such as
-`buttons <https://github.com/adafruit/Adafruit_CircuitPython_Display_Button>`_.
+Mouse cursor for interaction with CircuitPython UI elements.
+
 
 Dependencies
 =============
@@ -31,18 +31,21 @@ 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!
 
+.. todo:: Remove the above note if PyPI version is/will be available at time of release.
+   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
+
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-cursor/>`_. To install for current user:
+PyPI <https://pypi.org/project/adafruit-circuitpython-cursorcontrol/>`_. To install for current user:
 
 .. code-block:: shell
 
-    pip3 install adafruit-circuitpython-cursor
+    pip3 install adafruit-circuitpython-cursorcontrol
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    sudo pip3 install adafruit-circuitpython-cursor
+    sudo pip3 install adafruit-circuitpython-cursorcontrol
 
 To install in a virtual environment in your current project:
 
@@ -51,18 +54,18 @@ To install in a virtual environment in your current project:
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate
-    pip3 install adafruit-circuitpython-cursor
+    pip3 install adafruit-circuitpython-cursorcontrol
 
 Usage Example
 =============
 
-See examples in examples/ folder.
+.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
 
 Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
-<https://github.com/adafruit/Adafruit_CircuitPython_Cursor/blob/master/CODE_OF_CONDUCT.md>`_
+<https://github.com/adafruit/Adafruit_CircuitPython_CursorControl/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
 
 Building locally
@@ -90,7 +93,7 @@ Then run the build:
 
 .. code-block:: shell
 
-    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursor --library_location .
+    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-cursorcontrol --library_location .
 
 Sphinx documentation
 -----------------------

adafruit_cursor.py

@@ -0,0 +1,53 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2019 Brent Rubell for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_cursorcontrol`
+================================================================================
+
+Mouse cursor for interaction with CircuitPython UI elements.
+
+
+* Author(s): Brent Rubell
+
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST
+   inline format: "* `Link Text <url>`_"
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://github.com/adafruit/circuitpython/releases
+
+.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either.
+
+# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+"""
+
+# imports
+
+__version__ = "0.0.0-auto.0"
+__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl.git"

adafruit_cursorcontrol.py

@@ -4,5 +4,5 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
-.. automodule:: adafruit_cursor
+.. automodule:: adafruit_cursorcontrol
    :members:

docs/api.rst

@@ -20,7 +20,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["displayio"]
+# autodoc_mock_imports = ["digitalio", "busio"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
@@ -34,7 +34,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Adafruit Cursor Library'
+project = u'Adafruit CursorControl Library'
 copyright = u'2019 Brent Rubell'
 author = u'Brent Rubell'
 
@@ -109,7 +109,7 @@
 html_favicon = '_static/favicon.ico'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitCursorLibrarydoc'
+htmlhelp_basename = 'AdafruitCursorcontrolLibrarydoc'
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -135,7 +135,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'AdafruitCursorLibrary.tex', u'AdafruitCursor Library Documentation',
+    (master_doc, 'AdafruitCursorControlLibrary.tex', u'AdafruitCursorControl Library Documentation',
      author, 'manual'),
 ]
 
@@ -144,7 +144,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'AdafruitCursorlibrary', u'Adafruit Cursor Library Documentation',
+    (master_doc, 'AdafruitCursorControllibrary', u'Adafruit CursorControl Library Documentation',
      [author], 1)
 ]
 
@@ -154,7 +154,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitCursorLibrary', u'Adafruit Cursor Library Documentation',
-     author, 'AdafruitCursorLibrary', 'One line description of project.',
+    (master_doc, 'AdafruitCursorControlLibrary', u'Adafruit CursorControl Library Documentation',
+     author, 'AdafruitCursorControlLibrary', 'One line description of project.',
      'Miscellaneous'),
 ]

docs/conf.py

@@ -3,6 +3,6 @@ Simple test
 
 Ensure your device works with this simple test.
 
-.. literalinclude:: ../examples/cursor_simpletest.py
-    :caption: examples/cursor_simpletest.py
+.. literalinclude:: ../examples/cursorcontrol_simpletest.py
+    :caption: examples/cursorcontrol_simpletest.py
     :linenos: