Setup standard ECS GH workflows #9

slactjohnson · 2024-07-17T21:03:23Z

Description

Adds in standard ECS GH workflows.

Motivation and Context

Closes #8

How Has This Been Tested?

Will hopefully be tested when the workflows run on this PR....

tangkong · 2024-07-17T21:20:33Z

We transitioned to pyproject.toml for specifying test dependencies at some point. Try adding something like this to pyproject.toml

https://github.com/pcdshub/atef/blob/11b15c01dfafd9fe3c6d5ea39afd5844c071c339/pyproject.toml#L39-L40

Performed by pcds-migration-tools AddFileFromTemplate

Performed by pcds-migration-tools GitHubActionsMigration

Performed by pcds-migration-tools UpdateSphinx

Performed by pcds-migration-tools RunPyupgrade

Performed by pcds-migration-tools UpdateCondaRecipe

Performed by pcds-migration-tools RunPycln

Performed by pcds-migration-tools PrecommitAutoupdate

Performed by pcds-migration-tools RunPrecommit

ZLLentz · 2024-07-17T23:15:28Z

Wow, that's a lot of commits and a well earned "all checks have passed"

slactjohnson · 2024-07-17T23:22:14Z

Thanks! I'd appreciate a once over if you can to see if there's anything weird or missing in the CI. It passes, but that doesn't mean it's correct...

tangkong

I think this looks good on the whole, hard fought green checkmarks.

The builds/tests seem to be running as intended. Now it's just up to you to write tests that mean something.

tangkong · 2024-07-17T23:31:54Z

.coveragerc

@@ -1,6 +1,6 @@
 [run]
 source =
-    btms_ui
+    btms-ui


Your experience here is why I dislike using dashes at all in package names

tangkong · 2024-07-17T23:34:39Z

btms_ui/helpers.py

@@ -34,8 +32,8 @@ def __init__(
        self,
        x: float = 0.0,
        y: float = 0.0,
-        channel_x: Optional[str] = None,
-        channel_y: Optional[str] = None,
+        channel_x: str | None = None,


This syntax was introduced in py3.10, though the from __future__ import annotations lets you use it. I tend to not use it to be safe, but it's fine here it seems

I think one of the linters asks you to change everything to this

Interestingly none of the packages I work on do this yet 😆

tangkong · 2024-07-17T23:38:20Z

conda-recipe/meta.yaml

-
-{% set data = load_setup_py_data() %}
-
+{% set package_name = "btms_ui" %}


Now that both the package name and import name are btms_ui, we might consider renaming the repo and folder structure to use underscores to be consistent

ZLLentz · 2024-07-17T23:40:28Z

btms_ui/__init__.py

@@ -1,4 +1,3 @@
-from . import _version
-__version__ = _version.get_versions()['version']
+from ._version import __version__  # noqa: F401


This might be missing when running interactively since it's generated by setuptools_scm later.

I can't say I fully understand here, but it's working interactively on my clone. Once this is merged I can set up a clean clone and test that it still works interactively, and if not set up a new issue/PR to resolve that.

ZLLentz

I didn't compare 1:1 with any other repo but to my eyes everything here looks correct aside from the thing that might ImportError for dev clones

tangkong · 2024-07-17T23:41:27Z

pyproject.toml

+description = "Beam Transport Motion System GUI and python code"
+dynamic = [ "version", "readme", "dependencies", "optional-dependencies",]
+keywords = []
+name = "btms-ui"


This conflicts with the conda package name being btms_ui. The builds confirm this:

pip: btms-ui 0.1.dev135+g9befb1c.d20240717

conda: btms_ui 0.1.dev135+g9befb1c py_0 local

I've updated pyproject.toml to be consistent now

tangkong

I think this looks good, one last nitpick then I think we're good to merge this and tackle any followup bugs after.

These migration diffs are always hard to parse. Luckily the green check is a good indicator of success

pyproject.toml

Co-authored-by: Robert Tang-Kong <35379409+tangkong@users.noreply.github.com>

slactjohnson · 2024-07-18T17:33:46Z

@tangkong I've committed your suggestion to fix README.rst, but now it requires a review again. Can you approve when you get a chance so I can merge?

slactjohnson · 2024-07-18T17:38:03Z

Thank you!

slactjohnson added 2 commits July 17, 2024 14:01

Setup standard ECS GH workflows

455040c

Try with underscore rather than dash on package name

5885163

slactjohnson added 27 commits July 17, 2024 14:30

Add dev-requirements.txt to pyproject.toml

db0146c

MNT: updating LICENSE from template

70923f8

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating AUTHORS.rst from template

53faf2a

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating CONTRIBUTING.rst from template

cc6db60

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating .pre-commit-config.yaml from template

d5f5c66

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating .flake8 from template

d810c1e

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating .coveragerc from template

b36a0a5

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating .git_archival.txt from template

7b717ec

Performed by pcds-migration-tools AddFileFromTemplate

MNT: updating .gitattributes from template

d6142d1

Performed by pcds-migration-tools AddFileFromTemplate

CI: migrate to GitHub actions

6db134b

Performed by pcds-migration-tools GitHubActionsMigration

DOC: update Sphinx configuration

c60d466

Performed by pcds-migration-tools UpdateSphinx

STY: update repository to Python 3.9+ standards

86b6c01

Performed by pcds-migration-tools RunPyupgrade

BLD: update conda-recipe

0584731

Performed by pcds-migration-tools UpdateCondaRecipe

MNT: cleaning code with pycln

dc65a7e

Performed by pcds-migration-tools RunPycln

DEV: 'pre-commit autoupdate'

3c8f1bc

Performed by pcds-migration-tools PrecommitAutoupdate

MNT: 'pre-commit run'

191812f

Performed by pcds-migration-tools RunPrecommit

Make more sophisticated pyproject.toml

e65b028

Try underscore again

1a545c4

Actually read the error message and try to modify the right thing

5dfe672

Try updating package name

51b5126

Try out PCDS _version.py

aed0f7a

Follow pcdsdevices __version__ example

1d2adaa

Add in flake8 linter ignore to __init__.py

38cfd8a

Make the dummy test pass

ffa2329

Fix precommit issues

3acf10c

Fix pre-commit-config.yaml _version path

98d55e7

Fix flake8 path

8c7e186

slactjohnson added 3 commits July 17, 2024 16:01

Fix flake8 errors in dummy test

9b10cd6

Fix path to exclude tests from flake8

bb75759

Remove pin on pyqt to try to appease CI

9a79bbc

slactjohnson requested review from ZLLentz and tangkong July 17, 2024 23:20

tangkong reviewed Jul 17, 2024

View reviewed changes

ZLLentz reviewed Jul 17, 2024

View reviewed changes

tangkong reviewed Jul 17, 2024

View reviewed changes

Make project name consistent with conda package name in pyproject.toml

e9e408a

tangkong previously approved these changes Jul 18, 2024

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

Update pyproject.toml

f97735c

Co-authored-by: Robert Tang-Kong <35379409+tangkong@users.noreply.github.com>

slactjohnson dismissed tangkong’s stale review via f97735c July 18, 2024 16:15

tangkong approved these changes Jul 18, 2024

View reviewed changes

slactjohnson merged commit 680c878 into pcdshub:master Jul 18, 2024
11 checks passed

tangkong mentioned this pull request Jul 29, 2024

PR to support a more flexible camera naming. #16

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup standard ECS GH workflows #9

Setup standard ECS GH workflows #9

slactjohnson commented Jul 17, 2024

tangkong commented Jul 17, 2024

ZLLentz commented Jul 17, 2024

slactjohnson commented Jul 17, 2024

tangkong left a comment

tangkong Jul 17, 2024

tangkong Jul 17, 2024

ZLLentz Jul 17, 2024

tangkong Jul 17, 2024

tangkong Jul 17, 2024

ZLLentz Jul 17, 2024

slactjohnson Jul 18, 2024

ZLLentz left a comment

tangkong Jul 17, 2024

slactjohnson Jul 18, 2024

tangkong left a comment

slactjohnson commented Jul 18, 2024

slactjohnson commented Jul 18, 2024


		{% set data = load_setup_py_data() %}

		{% set package_name = "btms_ui" %}

Setup standard ECS GH workflows #9

Setup standard ECS GH workflows #9

Conversation

slactjohnson commented Jul 17, 2024

Description

Motivation and Context

How Has This Been Tested?

tangkong commented Jul 17, 2024

ZLLentz commented Jul 17, 2024

slactjohnson commented Jul 17, 2024

tangkong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZLLentz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tangkong left a comment

Choose a reason for hiding this comment

slactjohnson commented Jul 18, 2024

slactjohnson commented Jul 18, 2024