rename of dls-python3-skeleton

Author: gilesknap

CHANGELOG.rst

@@ -2,7 +2,7 @@ Changelog
 =========
 
 The changelog for the skeleton module is the list of `closed pull requests
-<https://github.com/epics-containers/dls-python3-skeleton/pulls?q=is%3Apr+is%3Aclosed>`_
+<https://github.com/epics-containers/python3-pip-skeleton/pulls?q=is%3Apr+is%3Aclosed>`_
 
 All developments for the ``skeleton`` branch take place via pull requests, and
 changes to the commandline tools and docs are not tracked in a changelog.

Pipfile.lock

@@ -19,7 +19,7 @@ It integrates the following tools:
 
 - pip and setuptools_scm for version management
 - Pre-commit with black, flake8 and isort for static analysis
-- Pytest for tests and code [email protected]:dls-controls/dls-python3-skeleton.gitcoverage
+- Pytest for tests and code [email protected]:dls-controls/python3-pip-skeleton.gitcoverage
 - Sphinx for tutorials, how-to guides, explanations and reference documentation
 - GitHub Actions for code and docs CI and deployment to PyPI and GitHub Pages
 - tox -p: runs pre-commit, pytest, mypy and make docs

README.rst

@@ -4,7 +4,7 @@ How to adopt the skeleton in an existing repo
 If you have an existing repo and would like to adopt the skeleton structure
 then you can use the commandline tool to merge the skeleton into your repo::
 
-    dls-python3-skeleton existing /path/to/existing/repo
+    python3-pip-skeleton existing /path/to/existing/repo
 
 This will:
 
@@ -27,7 +27,7 @@ adoption looks like. The commandline tool was run on the existing repo::
     $ cd /path/to/scanspec
     $ git checkout -b adopt-skeleton
     Switched to a new branch 'adopt-skeleton'
-    $ dls-python3-skeleton existing .
+    $ python3-pip-skeleton existing .
     Auto-merging src/scanspec/__main__.py
     CONFLICT (add/add): Merge conflict in src/scanspec/__main__.py
     Auto-merging src/scanspec/__init__.py

docs/how-to/existing.rst

@@ -6,9 +6,9 @@ structure in an existing repo) some time ago, there may be some changes to the
 structure that you could pick up. You can optionally check what differences
 these changes make to the files by doing::
 
-    $ git fetch https://github.com/epics-containers/dls-python3-skeleton skeleton
+    $ git fetch https://github.com/epics-containers/python3-pip-skeleton skeleton
     $ git diff ...FETCH_HEAD
 
 To merge the changes in do::
 
-    $ git pull https://github.com/epics-containers/dls-python3-skeleton skeleton
+    $ git pull https://github.com/epics-containers/python3-pip-skeleton skeleton

docs/how-to/update.rst

@@ -4,7 +4,7 @@ Creating a new repo from the skeleton
 Once you have followed the `installation` tutorial, you can use the
 commandline tool to make a new repo that inherits the skeleton::
 
-    dls-python3-skeleton new /path/to/be/created
+    python3-pip-skeleton new /path/to/be/created
 
 This will:
 

docs/tutorials/new.rst

@@ -12,7 +12,7 @@
 __all__ = ["main"]
 
 # The source of the skeleton module to pull from
-SKELETON = "https://github.com/epics-containers/dls-python3-skeleton"
+SKELETON = "https://github.com/epics-containers/python3-pip-skeleton"
 # The name of the merge branch that will be created
 MERGE_BRANCH = "skeleton-merge-branch"
 # Extensions to change
@@ -66,7 +66,7 @@ def merge_skeleton(
 
     def replace_text(text: str) -> str:
         text = text.replace("epics-containers", org)
-        text = text.replace("dls-python3-skeleton", repo)
+        text = text.replace("python3-pip-skeleton", repo)
         text = text.replace("python3_pip_skeleton", package)
         text = text.replace("Firstname Lastname", full_name)
         text = text.replace("[email protected]", email)
@@ -77,7 +77,7 @@ def replace_text(text: str) -> str:
     if MERGE_BRANCH in branches:
         raise Exception(
             f"{MERGE_BRANCH} already exists. \
-                Please run 'dls-python3-skeleton clean' to remove it."
+                Please run 'python3-pip-skeleton clean' to remove it."
         )
     with GitTemporaryDirectory() as git_tmp:
         # Clone existing repo into tmp so we don't mess up if we fail
@@ -120,7 +120,7 @@ def replace_text(text: str) -> str:
                     + replace_text(text[end_ignore:])
                 )
         # Commit what we have and push to the original repo
-        git_tmp("commit", "-a", "-m", f"Rename dls-python3-skeleton -> {repo}")
+        git_tmp("commit", "-a", "-m", f"Rename python3-pip-skeleton -> {repo}")
         git_tmp("push", "origin", MERGE_BRANCH)
     try:
         git("merge", MERGE_BRANCH, "--allow-unrelated-histories", cwd=path)

src/python3_pip_skeleton/__main__.py

@@ -49,10 +49,7 @@ def test_new_module(tmp_path: Path):
         for line in (module / "docs" / "reference" / "api.rst").read_text().splitlines()
         if "versiongit" in line
     ]
-    assert (
-        "    Version number as calculated by https://github.com/epics-containers/versiongit"
-        in versiongit_lines
-    )
+    assert "    Version number as calculated by setuptools_scm" in versiongit_lines
     assert (module / "src" / "my_module").is_dir()
     assert check_output("git", "branch", cwd=module).strip() == "* main"
     check_output("virtualenv", ".venv", cwd=module)
@@ -129,7 +126,7 @@ def test_existing_module(tmp_path: Path):
         )
     assert (
         f"{MERGE_BRANCH} already exists. \
-                Please run 'dls-python3-skeleton clean' to remove it."
+                Please run 'python3-pip-skeleton clean' to remove it."
         in str(excinfo.value)
     )
 
@@ -154,7 +151,7 @@ def test_existing_module_already_adopted(tmp_path: Path):
         "clone",
         "--branch",
         "0.5.4",  # dls-python3-skeleton was adopted in this release
-        "https://github.com/epics-containers/scanspec",
+        "https://github.com/dls-controls/scanspec",
         str(module),
     )
     with pytest.raises(Exception) as excinfo: