Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Setup python
uses: actions/setup-python@v4
Expand Down Expand Up @@ -48,7 +48,7 @@ jobs:
git config --global user.name "Your Name"

- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0

Expand Down Expand Up @@ -78,7 +78,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
run: sudo apt-get install graphviz

- name: checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs_clean.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:

steps:
- name: checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
ref: gh-pages

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
fetch-depth: 0

Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Changelog
=========

The changelog for the skeleton module is the list of `closed pull requests
<https://github.com/epics-containers/python3-pip-skeleton/pulls?q=is%3Apr+is%3Aclosed>`_
<https://github.com/DiamondLightSource/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.
14 changes: 7 additions & 7 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ are two sorts of contributions:
the cli-repo_ with with a PR raised back to the ``main`` branch
here: PR2_

.. _skeleton-repo: https://github.com/epics-containers/python3-pip-skeleton
.. _cli-repo: https://github.com/epics-containers/python3-pip-skeleton-cli
.. _PR: https://github.com/epics-containers/python3-pip-skeleton/pulls
.. _PR2: https://github.com/epics-containers/python3-pip-skeleton-cli/pulls
.. _skeleton-repo: https://github.com/DiamondLightSource/python3-pip-skeleton
.. _cli-repo: https://github.com/DiamondLightSource/python3-pip-skeleton-cli
.. _PR: https://github.com/DiamondLightSource/python3-pip-skeleton/pulls
.. _PR2: https://github.com/DiamondLightSource/python3-pip-skeleton-cli/pulls

Apart from this, ``main`` branch in both repos should always be deployable,
and are considered the latest release.
Expand All @@ -32,7 +32,7 @@ To run in a container

Use vscode devcontainer as follows::

$ git clone git://github.com/epics-containers/python3-pip-skeleton.git
$ git clone git://github.com/DiamondLightSource/python3-pip-skeleton.git
$ vscode python3-pip-skeleton
Click on 'Reopen in Container' when prompted
In a vscode Terminal:
Expand All @@ -45,7 +45,7 @@ To run locally
Get the source source code and run the unit tests directly
on your workstation as follows::

$ git clone git://github.com/epics-containers/python3-pip-skeleton.git
$ git clone git://github.com/DiamondLightSource/python3-pip-skeleton.git
$ cd python3-pip-skeleton
$ virtualenv .venv
$ source .venv/bin/activate
Expand Down Expand Up @@ -152,7 +152,7 @@ When this happens:
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/epics-containers/python3-pip-skeleton/releases
.. _release: https://github.com/DiamondLightSource/python3-pip-skeleton/releases


Checking Dependencies
Expand Down
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Python projects.

============== ==============================================================
PyPI ``pip install python3-pip-skeleton``
Source code https://github.com/epics-containers/python3-pip-skeleton-cli
Documentation https://epics-containers.github.io/python3-pip-skeleton-cli
Releases https://github.com/epics-containers/python3-pip-skeleton-cli/releases
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
============== ==============================================================

It integrates the following tools:
Expand All @@ -31,7 +31,7 @@ code that can be merged into new or existing projects, and pulled from to
keep them up to date. It can also serve as a working example for those who
would prefer to cherry-pick.

.. _skeleton: https://github.com/epics-containers/python3-pip-skeleton
.. _skeleton: https://github.com/DiamondLightSource/python3-pip-skeleton

This ``python3-pip-skeleton-cli`` repo contains the
docs and a command line tool to ease the adoption of this skeleton into a
Expand All @@ -43,16 +43,16 @@ and existing projects::

python3-pip-skeleton existing /path/to/existing/repo --org my_github_user_or_org

.. |code_ci| image:: https://github.com/epics-containers/python3-pip-skeleton/workflows/Code%20CI/badge.svg?branch=main
:target: https://github.com/epics-containers/python3-pip-skeleton/actions?query=workflow%3A%22Code+CI%22
.. |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
:alt: Code CI

.. |docs_ci| image:: https://github.com/epics-containers/python3-pip-skeleton/workflows/Docs%20CI/badge.svg?branch=main
:target: https://github.com/epics-containers/python3-pip-skeleton/actions?query=workflow%3A%22Docs+CI%22
.. |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
:alt: Docs CI

.. |coverage| image:: https://codecov.io/gh/epics-containers/python3-pip-skeleton/branch/main/graph/badge.svg
:target: https://codecov.io/gh/epics-containers/python3-pip-skeleton
.. |coverage| image:: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton/branch/main/graph/badge.svg
:target: https://codecov.io/gh/DiamondLightSource/python3-pip-skeleton
:alt: Test Coverage

.. |pypi_version| image:: https://img.shields.io/pypi/v/python3-pip-skeleton.svg
Expand All @@ -67,5 +67,5 @@ and existing projects::
Anything below this line is used when viewing README.rst and will be replaced
when included in index.rst

See https://epics-containers.github.io/python3-pip-skeleton-cli for
See https://DiamondLightSource.github.io/python3-pip-skeleton-cli for
more detailed documentation.
2 changes: 1 addition & 1 deletion docs/explanations/skeleton.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The python3-pip-skeleton_ repo has a protected main branch and is restricted to
rebase PRs only.
It is also squashed occasionally so some careful procedures are required.

.. _python3-pip-skeleton: https://github.com/epics-containers/python3-pip-skeleton
.. _python3-pip-skeleton: https://github.com/DiamondLightSource/python3-pip-skeleton

main
----
Expand Down
4 changes: 2 additions & 2 deletions docs/how-to/update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/python3-pip-skeleton main
$ git fetch https://github.com/DiamondLightSource/python3-pip-skeleton main
$ git diff ...FETCH_HEAD

To merge the changes in do::

$ git pull https://github.com/epics-containers/python3-pip-skeleton main
$ git pull https://github.com/DiamondLightSource/python3-pip-skeleton main
2 changes: 1 addition & 1 deletion docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Technical reference material including APIs and release notes.
.. toctree::
:caption: Reference

Releases <https://github.com/epics-containers/python3-pip-skeleton/releases>
Releases <https://github.com/DiamondLightSource/python3-pip-skeleton/releases>
Index <genindex.html#http://>

..
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You can now use ``pip`` to install the library::
If you require a feature that is not currently released you can also install
from github::

python3 -m pip install git+https://github.com/epics-containers/python3-pip-skeleton-cli.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::
Expand All @@ -42,4 +42,4 @@ Running in a container

To pull the container from github container registry and run::

docker run ghcr.io/epics-containers/python3-pip-skeleton:main --version
docker run ghcr.io/DiamondLightSource/python3-pip-skeleton:main --version
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[metadata]
name = python3-pip-skeleton
description = One line description of your module
url = https://github.com/epics-containers/python3-pip-skeleton
url = https://github.com/DiamondLightSource/python3-pip-skeleton
author = Firstname Lastname
author_email = email@address.com
license = Apache License 2.0
Expand Down Expand Up @@ -32,7 +32,7 @@ setup_requires =
[options.extras_require]
# For development tests/docs
dev =
black==22.6.0
black==22.8.0
flake8-isort
isort>5.0
mypy
Expand Down
6 changes: 3 additions & 3 deletions src/python3_pip_skeleton/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
__all__ = ["main"]

# The source of the skeleton module to pull from
SKELETON = "https://github.com/epics-containers/python3-pip-skeleton"
SKELETON = "https://github.com/DiamondLightSource/python3-pip-skeleton"
# The name of the merge branch that will be created
MERGE_BRANCH = "skeleton-merge-branch"
# Extensions to change
Expand All @@ -24,7 +24,7 @@
"CONTRIBUTING.rst": ("\nUpdating the tools\n", None),
}

SKELETON_ROOT_COMMIT = "ededf00035e6ccfac78946213009c1ecd7c110a9"
SKELETON_ROOT_COMMIT = "de6d5f161b940ebd052ee3123a7250a0776dcf50"


def git(*args, cwd=None) -> str:
Expand Down Expand Up @@ -62,7 +62,7 @@ def merge_skeleton(
repo = path.name

def replace_text(text: str) -> str:
text = text.replace("epics-containers", org)
text = text.replace("DiamondLightSource", org)
text = text.replace("python3-pip-skeleton", repo)
text = text.replace("python3_pip_skeleton", package)
text = text.replace("Firstname Lastname", full_name)
Expand Down