Skip to content

Commit 7828330

Browse files
committed
Rename everything to be related to the name TechUI Builder
1 parent f753f90 commit 7828330

17 files changed

Lines changed: 766 additions & 672 deletions

.copier-answers.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ component_lifecycle: experimental
77
component_owner: group:default/sscc
88
component_type: library
99
description: A package for building GUIs
10-
distribution_name: phoebus-guibuilder
10+
distribution_name: techui-builder
1111
docker: true
1212
docs_type: README
1313
git_platform: github.com
1414
github_org: DiamondLightSource
15-
package_name: phoebus_guibuilder
15+
package_name: techui_builder
1616
pypi: false
17-
repo_name: phoebus-guibuilder
17+
repo_name: techui-builder
1818
type_checker: pyright

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Contribute to the project
22

33
Contributions and issues are most welcome! All issues and pull requests are
4-
handled through [GitHub](https://github.com/DiamondLightSource/phoebus-guibuilder/issues). Also, please check for any existing issues before
4+
handled through [GitHub](https://github.com/DiamondLightSource/techui-builder/issues). Also, please check for any existing issues before
55
filing a new one. If you have a great idea but it involves big changes, please
66
file a ticket before making a pull request! We want to make sure you don't spend
77
your time coding something that might not fit the scope of the project.
88

99
## Issue or Discussion?
1010

11-
Github also offers [discussions](https://github.com/DiamondLightSource/phoebus-guibuilder/discussions) as a place to ask questions and share ideas. If
11+
Github also offers [discussions](https://github.com/DiamondLightSource/techui-builder/discussions) as a place to ask questions and share ideas. If
1212
your issue is open ended and it is not obvious when it can be "closed", please
1313
raise it as a discussion instead.
1414

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ ENV VIRTUAL_ENV=/venv
4040
ENV PATH=$VIRTUAL_ENV/bin:$PATH
4141

4242
# change this entrypoint if it is not the same as the repo
43-
ENTRYPOINT ["phoebus-guibuilder"]
43+
ENTRYPOINT ["techui-builder"]
4444
CMD ["--version"]

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
[![CI](https://github.com/DiamondLightSource/phoebus-guibuilder/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/phoebus-guibuilder/actions/workflows/ci.yml)
2-
[![Coverage](https://codecov.io/gh/DiamondLightSource/phoebus-guibuilder/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/phoebus-guibuilder)
1+
[![CI](https://github.com/DiamondLightSource/techui-builder/actions/workflows/ci.yml/badge.svg)](https://github.com/DiamondLightSource/techui-builder/actions/workflows/ci.yml)
2+
[![Coverage](https://codecov.io/gh/DiamondLightSource/techui-builder/branch/main/graph/badge.svg)](https://codecov.io/gh/DiamondLightSource/techui-builder)
33

44
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
55

6-
# phoebus_guibuilder
6+
# techui_builder
77

88
A package for building GUIs
99

1010
This is where you should write a short paragraph that describes what your module does,
1111
how it does it, and why people should use it.
1212

13-
Source | <https://github.com/DiamondLightSource/phoebus-guibuilder>
13+
Source | <https://github.com/DiamondLightSource/techui-builder>
1414
:---: | :---:
15-
Docker | `docker run ghcr.io/diamondlightsource/phoebus-guibuilder:latest`
16-
Releases | <https://github.com/DiamondLightSource/phoebus-guibuilder/releases>
15+
Docker | `docker run ghcr.io/diamondlightsource/techui-builder:latest`
16+
Releases | <https://github.com/DiamondLightSource/techui-builder/releases>
1717

1818
This is where you should put some images or code snippets that illustrate
1919
some relevant examples. If it is a library then you might put some
2020
introductory code here:
2121

2222
```python
23-
from phoebus_guibuilder import __version__
23+
from techui_builder import __version__
2424

25-
print(f"Hello phoebus_guibuilder {__version__}")
25+
print(f"Hello techui_builder {__version__}")
2626
```
2727

2828
Or if it is a commandline tool then you might put some example commands here:
2929

3030
```
31-
python -m phoebus_guibuilder --version
31+
python -m techui_builder --version
3232
```

catalog-info.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
apiVersion: backstage.io/v1alpha1
22
kind: Component
33
metadata:
4-
name: phoebus-guibuilder
5-
title: phoebus-guibuilder
4+
name: techui-builder
5+
title: techui-builder
66
description: A package for building GUIs
77
spec:
88
type: library

docs/conf.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@
1212

1313
import requests
1414

15-
import phoebus_guibuilder
15+
import techui_builder
1616

1717
# -- General configuration ------------------------------------------------
1818
sys.path.insert(0, os.path.abspath("../../src"))
1919
# General information about the project.
20-
project = "phoebus-guibuilder"
20+
project = "techui-builder"
2121
copyright = "2025, Diamond Light Source"
2222

2323
# The full version, including alpha/beta/rc tags.
24-
release = phoebus_guibuilder.__version__
24+
release = techui_builder.__version__
2525

2626
# The short X.Y version.
2727
if "+" in release:
@@ -89,7 +89,7 @@
8989
autodoc_inherit_docstrings = False
9090

9191
# Add some more modules to the top level autosummary
92-
phoebus_guibuilder.__all__ += []
92+
techui_builder.__all__ += []
9393

9494
# Document only what is in __all__
9595
autosummary_ignore_module_all = False
@@ -152,9 +152,9 @@
152152
# a list of builtin themes.
153153
#
154154
html_theme = "pydata_sphinx_theme"
155-
github_repo = "phoebus-guibuilder"
155+
github_repo = "techui-builder"
156156
github_user = "DiamondLightSource"
157-
switcher_json = "https://diamondlightsource.github.io/phoebus-guibuilder/switcher.json"
157+
switcher_json = "https://diamondlightsource.github.io/techui-builder/switcher.json"
158158
switcher_exists = requests.get(switcher_json).ok
159159
if not switcher_exists:
160160
print(
@@ -208,8 +208,8 @@
208208
html_show_copyright = False
209209

210210
# Logo
211-
# html_logo = "images/phoebus-guibuilder-logo.svg"
212-
# html_favicon = "images/phoebus-guibuilder-favicon.svg"
211+
# html_logo = "images/techui-builder-logo.svg"
212+
# html_favicon = "images/techui-builder-favicon.svg"
213213

214214
# If False and a module has the __all__ attribute set, autosummary documents
215215
# every member listed in __all__ and no others. Default is True

motor.bob

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<display version="2.0.0">
3+
<name>motor</name>
4+
<widget type="embedded" version="2.0.0">
5+
<name>pmac.autohome</name>
6+
<x>10</x>
7+
<y>10</y>
8+
<width>700</width>
9+
<height>700</height>
10+
<file>./techui-support/bob/Homing-axis.bob</file>
11+
<macros>
12+
<P>BL01T-MO-MAP-01:STAGE</P>
13+
<M/>
14+
</macros>
15+
</widget>
16+
<widget type="embedded" version="2.0.0">
17+
<name>:X</name>
18+
<x>12</x>
19+
<y>12</y>
20+
<width>700</width>
21+
<height>700</height>
22+
<file>./techui-support/bob/MOTOR.bob</file>
23+
<macros>
24+
<P>BL01T-MO-MAP-01:STAGE</P>
25+
<M>:X</M>
26+
</macros>
27+
</widget>
28+
<widget type="embedded" version="2.0.0">
29+
<name>:A</name>
30+
<x>14</x>
31+
<y>14</y>
32+
<width>700</width>
33+
<height>700</height>
34+
<file>./techui-support/bob/MOTOR.bob</file>
35+
<macros>
36+
<P>BL01T-MO-MAP-01:STAGE</P>
37+
<M>:A</M>
38+
</macros>
39+
</widget>
40+
</display>

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[project]
2-
name = "phoebus-guibuilder"
2+
name = "techui-builder"
33
dynamic = ["version"]
44
description = "A package for building GUIs"
55
classifiers = [
66
"Development Status :: 3 - Alpha",
77
"License :: OSI Approved :: BSD License",
88
"Programming Language :: Python :: 3.12",
99
]
10-
urls = { GitHub = "https://github.com/DiamondLightSource/phoebus-guibuilder" }
10+
urls = { GitHub = "https://github.com/DiamondLightSource/techui-builder" }
1111
authors = [
1212
{ name = "Oliver Copping", email = "oliver.copping@diamond.ac.uk" },
1313
{ name = "Adedamola Sode", email = "adedamola.sode@diamond.ac.uk" },
@@ -16,7 +16,7 @@ license = { file = "LICENSE" }
1616
readme = "README.md"
1717
requires-python = ">=3.12,<4.0"
1818
dependencies = ["pyyaml>=6.0.2", "phoebusgen>=3.0.0"]
19-
scripts = { phoebus-guibuilder = "phoebus_guibuilder.__main__:main" }
19+
scripts = { techui-builder = "techui_builder.__main__:main" }
2020
optional-dependencies = { dev = [
2121
"basedpyright>=1.27.1",
2222
"hatch>=1.14.0",
@@ -57,7 +57,7 @@ tag-pattern = "(?P<version>([1-9][0-9]*!)?(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))*((
5757
raw-options = { version_scheme = "only-version", local_scheme = "dirty-tag" }
5858

5959
[tool.hatch.build.hooks.vcs]
60-
version-file = "src/phoebus_guibuilder/_version.py"
60+
version-file = "src/techui_builder/_version.py"
6161
template = '''
6262
# This file is automatically generated by Hatch
6363
# Do not modify this file directly
@@ -92,7 +92,7 @@ asyncio_mode = "auto"
9292
asyncio_default_fixture_loop_scope = "function"
9393

9494
[tool.coverage.run]
95-
data_file = "/tmp/phoebus_guibuilder.coverage"
95+
data_file = "/tmp/techui_builder.coverage"
9696

9797
[tool.coverage.paths]
9898
# Tests are run from installed location, map back to the src directory
@@ -121,7 +121,7 @@ scripts = { type-check = ["basedpyright --stats src {args}"] }
121121
[tool.hatch.envs.tests]
122122
description = "Run tests"
123123
scripts = { tests = [
124-
"pytest --cov=phoebus_guibuilder --cov-report term --cov-report xml:cov.xml {args}",
124+
"pytest --cov=techui_builder --cov-report term --cov-report xml:cov.xml {args}",
125125
] }
126126

127127
[tool.hatch.envs.docs]
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
Version number as calculated by poetry-dynamic-versioning
77
"""
88

9-
from phoebus_guibuilder.datatypes import Beamline, Component, Entry
10-
from phoebus_guibuilder.guibuilder import Guibuilder
11-
from phoebus_guibuilder.screen import TechUIScreens
9+
from techui_builder.builder import Builder
10+
from techui_builder.datatypes import Beamline, Component, Entry
11+
from techui_builder.screen import TechUIScreens
1212

1313
from ._version import __version__
1414

@@ -17,6 +17,6 @@
1717
"Beamline",
1818
"Component",
1919
"Entry",
20-
"Guibuilder",
20+
"Builder",
2121
"TechUIScreens",
2222
]
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
"""Interface for ``python -m phoebus_guibuilder``."""
1+
"""Interface for ``python -m techui_builder``."""
22

33
from argparse import ArgumentParser
44
from collections.abc import Sequence
55

66
from . import __version__
7-
from .guibuilder import Guibuilder
7+
from .builder import Builder
88

99
__all__ = ["main"]
1010

@@ -21,7 +21,7 @@ def main(args: Sequence[str] | None = None) -> None:
2121
)
2222
_args = parser.parse_args(args)
2323

24-
gb = Guibuilder(_args.filename)
24+
gb = Builder(_args.filename)
2525
gb.extract_from_create_gui()
2626

2727

0 commit comments

Comments
 (0)