change CircUp -> Circup

This commit is contained in:
foamyguy 2024-05-20 10:43:19 -05:00
parent c1e1b4b269
commit 99367e95a6
5 changed files with 9 additions and 9 deletions

View file

@ -91,7 +91,7 @@ subsequently used to facilitate the various commands the tool makes available.
These commands are defined at the very end of the ``circup.py`` code.
Unit tests can be found in the ``tests`` directory. CircUp uses
Unit tests can be found in the ``tests`` directory. Circup uses
`pytest <http://www.pytest.org/en/latest/>`_ style testing conventions. Test
functions should include a comment to describe its *intention*. We currently
have 100% unit test coverage for all the core functionality (excluding
@ -115,7 +115,7 @@ available options to help you work with the code base.
Before submitting a PR, please remember to ``pre-commit run --all-files``.
But if you forget the CI process in Github will run it for you. ;-)
CircUp uses the `Click <https://click.palletsprojects.com/en/7.x/>`_ module to
Circup uses the `Click <https://click.palletsprojects.com/en/7.x/>`_ module to
run command-line interaction. The
`AppDirs <https://pypi.org/project/appdirs/>`_ module is used to determine
where to store user-specific assets created by the tool in such a way that

View file

@ -1,5 +1,5 @@
CircUp
Circup
======
.. image:: https://readthedocs.org/projects/circup/badge/?version=latest
@ -39,7 +39,7 @@ If you have no idea what a virtualenv is, try the following command,
.. note::
If you use the ``pip3`` command to install CircUp you must make sure that
If you use the ``pip3`` command to install Circup you must make sure that
your path contains the directory into which the script will be installed.
To discover this path,
@ -76,7 +76,7 @@ Usage
-----
If you need more detailed help using Circup see the Learn Guide article
`"Use CircUp to easily keep your CircuitPython libraries up to date" <https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/>`_.
`"Use Circup to easily keep your CircuitPython libraries up to date" <https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/>`_.
First, plug in a device running CircuiPython. This should appear as a mounted
storage device called ``CIRCUITPY``.
@ -230,7 +230,7 @@ The ``--version`` flag will tell you the current version of the
``circup`` command itself::
$ circup --version
CircUp, A CircuitPython module updater. Version 0.0.1
Circup, A CircuitPython module updater. Version 0.0.1
To use circup via the `Web Workflow <https://learn.adafruit.com/getting-started-with-web-workflow-using-the-code-editor>`_. on devices that support it. Use the ``--host`` and ``--password`` arguments before your circup command.::

View file

@ -2,7 +2,7 @@
#
# SPDX-License-Identifier: MIT
"""
CircUp -- a utility to manage and update libraries on a CircuitPython device.
Circup -- a utility to manage and update libraries on a CircuitPython device.
"""

View file

@ -80,7 +80,7 @@ from circup.command_utils import (
"with --board-id, it overrides the detected CPy version.",
)
@click.version_option(
prog_name="CircUp",
prog_name="Circup",
message="%(prog)s, A CircuitPython module updater. Version %(version)s",
)
@click.pass_context

View file

@ -1,4 +1,4 @@
.. CircUp documentation master file, created by
.. Circup documentation master file, created by
sphinx-quickstart on Mon Sep 2 10:58:36 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.