diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f56c0fa..bb68fb9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -25,7 +25,7 @@ Developer Setup .. note:: - Please try to use Python 3.9+ while developing CircUp. This is so we can + Please try to use Python 3.9+ while developing Circup. This is so we can use the `Black code formatter `_ and so that we're supporting versions which still receive security updates. @@ -100,7 +100,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 `_ 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 @@ -124,7 +124,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 `_ module to +Circup uses the `Click `_ module to run command-line interaction. The `AppDirs `_ module is used to determine where to store user-specific assets created by the tool in such a way that diff --git a/README.rst b/README.rst index d22d575..bb31827 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ -CircUp +Circup ====== .. image:: https://readthedocs.org/projects/circup/badge/?version=latest @@ -28,7 +28,7 @@ A tool to manage and update libraries (modules) on a CircuitPython device. Installation ------------ -Circup requires Python 3.5 or higher. +Circup requires Python 3.9 or higher. In a `virtualenv `_, ``pip install circup`` should do the trick. This is the simplest way to make it @@ -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" `_. +`"Use Circup to easily keep your CircuitPython libraries up to date" `_. 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 `_. on devices that support it. Use the ``--host`` and ``--password`` arguments before your circup command.:: @@ -263,6 +263,7 @@ For Bash, add this to ~/.bashrc:: For Zsh, add this to ~/.zshrc:: + autoload -U compinit; compinit eval "$(_CIRCUP_COMPLETE=zsh_source circup)" For Fish, add this to ~/.config/fish/completions/foo-bar.fish:: diff --git a/circup/__init__.py b/circup/__init__.py index 41016b4..dde180f 100644 --- a/circup/__init__.py +++ b/circup/__init__.py @@ -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. """ diff --git a/circup/commands.py b/circup/commands.py index 4a57167..b85d16a 100644 --- a/circup/commands.py +++ b/circup/commands.py @@ -84,7 +84,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 diff --git a/docs/index.rst b/docs/index.rst index d06ef8f..17578b6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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.