Rename python3-pip-skeleton -> python3-pip-skeleton-cli

Author: coretl

.github/CONTRIBUTING.rst

@@ -7,7 +7,7 @@ filing a new one. If you have a great idea but it involves big changes, please
 file a ticket before making a pull request! We want to make sure you don't spend
 your time coding something that might not fit the scope of the project.
 
-.. _GitHub: https://github.com/DiamondLightSource/python3-pip-skeleton/issues
+.. _GitHub: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/issues
 
 Issue or Discussion?
 --------------------
@@ -16,7 +16,7 @@ Github also offers discussions_ as a place to ask questions and share ideas. If
 your issue is open ended and it is not obvious when it can be "closed", please
 raise it as a discussion instead.
 
-.. _discussions: https://github.com/DiamondLightSource/python3-pip-skeleton/discussions
+.. _discussions: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/discussions
 
 Code coverage
 -------------
@@ -32,4 +32,4 @@ The `Developer Guide`_ contains information on setting up a development
 environment, running the tests and what standards the code and documentation
 should follow.
 
-.. _Developer Guide: https://diamondlightsource.github.io/python3-pip-skeleton/main/developer/how-to/contribute.html
+.. _Developer Guide: https://diamondlightsource.github.io/python3-pip-skeleton-cli/main/developer/how-to/contribute.html

Dockerfile

@@ -44,5 +44,5 @@ COPY --from=build /venv/ /venv/
 ENV PATH=/venv/bin:$PATH
 
 # change this entrypoint if it is not the same as the repo
-ENTRYPOINT ["python3-pip-skeleton"]
+ENTRYPOINT ["python3-pip-skeleton-cli"]
 CMD ["--version"]

README.rst

@@ -1,4 +1,4 @@
-python3-pip-skeleton
+python3-pip-skeleton-cli
 ===========================
 
 |code_ci| |docs_ci| |coverage| |pypi_version| |license|
@@ -7,16 +7,16 @@ python3-pip-skeleton
 
     This project contains template code only. For documentation on how to
     adopt this skeleton project see
-    https://DiamondLightSource.github.io/python3-pip-skeleton-cli
+    https://DiamondLightSource.github.io/python3-pip-skeleton-cli-cli
 
 This is where you should write a short paragraph that describes what your module does,
 how it does it, and why people should use it.
 
 ============== ==============================================================
-PyPI           ``pip install python3-pip-skeleton``
-Source code    https://github.com/DiamondLightSource/python3-pip-skeleton
-Documentation  https://DiamondLightSource.github.io/python3-pip-skeleton
-Releases       https://github.com/DiamondLightSource/python3-pip-skeleton/releases
+PyPI           ``pip install python3-pip-skeleton-cli``
+Source code    https://github.com/DiamondLightSource/python3-pip-skeleton-cli
+Documentation  https://DiamondLightSource.github.io/python3-pip-skeleton-cli
+Releases       https://github.com/DiamondLightSource/python3-pip-skeleton-cli/releases
 ============== ==============================================================
 
 This is where you should put some images or code snippets that illustrate
@@ -33,20 +33,20 @@ Or if it is a commandline tool then you might put some example commands here::
 
     $ python -m python3_pip_skeleton --version
 
-.. |code_ci| image:: https://github.com/DiamondLightSource/python3-pip-skeleton/workflows/Code%20CI/badge.svg?branch=main
-    :target: https://github.com/DiamondLightSource/python3-pip-skeleton/actions?query=workflow%3A%22Code+CI%22
+.. |code_ci| image:: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/workflows/Code%20CI/badge.svg?branch=main
+    :target: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/actions?query=workflow%3A%22Code+CI%22
     :alt: Code CI
 
-.. |docs_ci| image:: https://github.com/DiamondLightSource/python3-pip-skeleton/workflows/Docs%20CI/badge.svg?branch=main
-    :target: https://github.com/DiamondLightSource/python3-pip-skeleton/actions?query=workflow%3A%22Docs+CI%22
+.. |docs_ci| image:: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/workflows/Docs%20CI/badge.svg?branch=main
+    :target: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/actions?query=workflow%3A%22Docs+CI%22
     :alt: Docs CI
 
-.. |coverage| image:: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton/branch/main/graph/badge.svg
-    :target: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton
+.. |coverage| image:: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton-cli/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton-cli
     :alt: Test Coverage
 
-.. |pypi_version| image:: https://img.shields.io/pypi/v/python3-pip-skeleton.svg
-    :target: https://pypi.org/project/python3-pip-skeleton
+.. |pypi_version| image:: https://img.shields.io/pypi/v/python3-pip-skeleton-cli.svg
+    :target: https://pypi.org/project/python3-pip-skeleton-cli
     :alt: Latest PyPI version
 
 .. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
@@ -57,4 +57,4 @@ Or if it is a commandline tool then you might put some example commands here::
     Anything below this line is used when viewing README.rst and will be replaced
     when included in index.rst
 
-See https://DiamondLightSource.github.io/python3-pip-skeleton for more detailed documentation.
+See https://DiamondLightSource.github.io/python3-pip-skeleton-cli for more detailed documentation.

docs/conf.py

@@ -12,7 +12,7 @@
 # -- General configuration ------------------------------------------------
 
 # General information about the project.
-project = "python3-pip-skeleton"
+project = "python3-pip-skeleton-cli"
 
 # The full version, including alpha/beta/rc tags.
 release = python3_pip_skeleton.__version__

docs/developer/how-to/make-release.rst

@@ -13,4 +13,4 @@ To make a new release, please follow this checklist:
 Note that tagging and pushing to the main branch has the same effect except that
 you will not get the option to edit the release notes.
 
-.. _release: https://github.com/DiamondLightSource/python3-pip-skeleton/releases
+.. _release: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/releases

docs/developer/tutorials/dev-install.rst

@@ -10,7 +10,7 @@ Clone the repository
 First clone the repository locally using `Git
 <https://git-scm.com/downloads>`_::
 
-    $ git clone git://github.com/DiamondLightSource/python3-pip-skeleton.git
+    $ git clone git://github.com/DiamondLightSource/python3-pip-skeleton-cli.git
 
 Install dependencies
 --------------------
@@ -25,7 +25,7 @@ requires python 3.8 or later) or to run in a container under `VSCode
 
         .. code::
 
-            $ cd python3-pip-skeleton
+            $ cd python3-pip-skeleton-cli
             $ python3 -m venv venv
             $ source venv/bin/activate
             $ pip install -e .[dev]
@@ -34,7 +34,7 @@ requires python 3.8 or later) or to run in a container under `VSCode
 
         .. code::
 
-            $ vscode python3-pip-skeleton
+            $ vscode python3-pip-skeleton-cli
             # Click on 'Reopen in Container' when prompted
             # Open a new terminal
 

docs/index.rst

@@ -14,13 +14,13 @@ The documentation is split into 2 sections:
         :link: user/index
         :link-type: doc
 
-        The User Guide contains documentation on how to install and use python3-pip-skeleton.
+        The User Guide contains documentation on how to install and use python3-pip-skeleton-cli.
 
     .. grid-item-card:: :material-regular:`code;4em`
         :link: developer/index
         :link-type: doc
 
-        The Developer Guide contains documentation on how to develop and contribute changes back to python3-pip-skeleton.
+        The Developer Guide contains documentation on how to develop and contribute changes back to python3-pip-skeleton-cli.
 
 .. toctree::
     :hidden:

docs/user/how-to/run-container.rst

@@ -1,15 +1,15 @@
 Run in a container
 ==================
 
-Pre-built containers with python3-pip-skeleton and its dependencies already
+Pre-built containers with python3-pip-skeleton-cli and its dependencies already
 installed are available on `Github Container Registry
-<https://ghcr.io/DiamondLightSource/python3-pip-skeleton>`_.
+<https://ghcr.io/DiamondLightSource/python3-pip-skeleton-cli>`_.
 
 Starting the container
 ----------------------
 
 To pull the container from github container registry and run::
 
-    $ docker run ghcr.io/DiamondLightSource/python3-pip-skeleton:main --version
+    $ docker run ghcr.io/DiamondLightSource/python3-pip-skeleton-cli:main --version
 
 To get a released version, use a numbered release instead of ``main``.

docs/user/tutorials/installation.rst

@@ -25,14 +25,14 @@ Installing the library
 
 You can now use ``pip`` to install the library and its dependencies::
 
-    $ python3 -m pip install python3-pip-skeleton
+    $ python3 -m pip install python3-pip-skeleton-cli
 
 If you require a feature that is not currently released you can also install
 from github::
 
-    $ python3 -m pip install git+https://github.com/DiamondLightSource/python3-pip-skeleton.git
+    $ python3 -m pip install git+https://github.com/DiamondLightSource/python3-pip-skeleton-cli.git
 
 The library should now be installed and the commandline interface on your path.
 You can check the version that has been installed by typing::
 
-    $ python3-pip-skeleton --version
+    $ python3-pip-skeleton-cli --version

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
-name = python3-pip-skeleton
+name = python3-pip-skeleton-cli
 description = One line description of your module
-url = https://github.com/DiamondLightSource/python3-pip-skeleton
+url = https://github.com/DiamondLightSource/python3-pip-skeleton-cli
 author = Firstname Lastname
 author_email = [email protected]
 license = Apache License 2.0
@@ -60,7 +60,7 @@ exclude = tests
 [options.entry_points]
 # Include a command line script
 console_scripts =
-    python3-pip-skeleton = python3_pip_skeleton.__main__:main
+    python3-pip-skeleton-cli = python3_pip_skeleton.__main__:main
 
 [mypy]
 # Ignore missing stubs for modules we use