Factor out `checks-superstaq` #789

perlinm · 2023-09-23T15:14:27Z

perlinm · 2023-09-23T15:25:49Z

There's definitely a lot going on in .github/workflows/ci.yaml that I don't understand. Help appreciated 😅.
I think my biggest confusion is when we should pip install -e ...-superstaq[dev] vs. without [dev].

~~Also: how should we control versioning of checks-superstaq? Related.~~ EDIT: solved with

perlinm · 2023-09-23T16:38:46Z

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
-          pip install -e ./general-superstaq[dev] -e ./qiskit-superstaq -e ./cirq-superstaq -e ./supermarq-benchmarks
+          pip install -e ./checks-superstaq -e ./general-superstaq -e ./qiskit-superstaq -e ./cirq-superstaq -e ./supermarq-benchmarks


Is there a particular reason for the pylint to not install [dev] versions?

nope, mostly there was just no reason to

I guess no need to add it then? Should I remove [dev] from some other places while we're at it? Maybe it doesn't matter?

it shouldn't really matter much i think - in practice the dev versions are often installed anyway because we usually use a shared cache. leaving it off can make that check a little faster after a cache miss, but the difference is probably pretty small

perlinm · 2023-09-23T16:42:02Z

UPDATE: Fixed with the third option below.

OLD:

The requirements check is failing because checks-superstaq is not on PyPI. So it's a chicken-and-egg problem. Maybe we comment out the requirements check in this PR, version bump in a second PR (which should deploy to PyPI), and then un-comment this check in a third PR?

Actually, I guess we can version bump in this PR(?)

Third option: if a package is installed locally and not found on PyPI, just check against the local version. I think I'll do this actually.

perlinm · 2023-09-24T03:10:48Z

checks-superstaq/checks_superstaq/requirements.py

+    try:
+        package_data = urllib.request.urlopen(pypi_url).read().decode()
+        pypi_version = json.loads(package_data)["info"]["version"]
+    except urllib.error.URLError:
+        return checks_superstaq.__version__


This is really a temporary fix for the fact that the requirements.py check would otherwise fail until checks-superstaq is on PyPI. Not unreasonable since we take the max of the PyPI and local package versions below anyways.

A soon-to-follow PR will change some things about requirements.py anyways, to make it independent of the other *-superstaq packages.

perlinm · 2023-09-24T16:08:29Z

I presume we should version bump to 0.5.0 in this PR?

richrines1

general-superstaq[dev] should be replaced with checks-superstaq in */dev-requirements.txt. Otherwise, just a few minor questions!

checks-superstaq/pyproject.toml

richrines1 · 2023-10-02T15:45:19Z

check/all_.py

 import sys

-import general_superstaq.check
+import checks_superstaq as check


out of curiosity - any reason for check instead of checks?

Nope. Maybe "this repo checks superstaq" is a fun play on words 😄?

I am happy to make this check-superstaq though, and even to consider different names entirely -- the naming collision between ./checks-superstaq/ and ./check/all_.py (for example) is a 👎 for tab completion.

haha i like "checks-superstaq" - i was mostly wondering if it would be more consistent to import it with as checks instead of as check (doesn't help with the tab-completion point though)

Ah, I see. Yeah import ... as checks makes sense to me

Oh I see I read your original comment backwards lol (swapping check and checks)

richrines1 · 2023-10-02T15:50:44Z

general-superstaq/pyproject.toml

@@ -5,7 +5,7 @@ authors = [
  { name = "Superstaq development team", email = "superstaq@infleqtion.com" },
 ]
 readme = { file = "README.md", content-type = "text/markdown" }
-license = { text = "Apache 2" }
+license = { text = "Apache-2.0" }


why this change? fwiw cirq uses "Apache 2" and qiskit uses "Apache 2.0" (with no hyphen)

I see Apache-2.0 on github, for example.

This is definitely not a big deal either way though.

~~I guess for the sake of neater git blame type stuff I'll leave it as it was before~~ haha nvm

ah good find, Apache-2.0 seem right then

Co-authored-by: richrines1 <85512171+richrines1@users.noreply.github.com>

richrines1

nice - this looks solid afaict

i think we should manually deploy checks-superstaq 0.4.25 to pypi, so from now it will be updated normally along with version bumps

perlinm · 2023-10-02T20:02:14Z

~~Why not just version bump in this PR? Wouldn't that deploy? I feel like it doesn't make sense to deploy checks-superstaq without simultaneously version bumping gss.~~

Nevermind. No reason to version bump in this PR.

![image](https://github.com/Infleqtion/client-superstaq/assets/567092/523e915e-351a-4265-aa2a-f095ad7eb084) --------- Co-authored-by: richrines1 <85512171+richrines1@users.noreply.github.com>

perlinm added 6 commits September 23, 2023 10:00

starting to factor out checks-superstaq

0afd752

minor bugfix in build_docs.py

96858dd

remove pyyaml from checks-superstaq and version bump

98972cc

Merge branch 'main' into factor-out-checks

781c9d0

add checks-superstaq to pypi

5d38368

update workflows

c2ef0af

perlinm added 6 commits September 23, 2023 10:27

fix check script imports of check_utils

27d8661

symlink checks-superstaq version from gss

d058567

remove dependency on gss

1bb567a

install gss for the standalone gss check

846b530

fix incorrect call to importlib.metadata.version

59ca261

add [dev] to some installs

73cf264

perlinm commented Sep 23, 2023

View reviewed changes

perlinm marked this pull request as ready for review September 23, 2023 16:45

perlinm requested review from richrines1, vtomole, singular-value, stephanielee9, teaguetomesh, knsmith, paaige and epelaaez as code owners September 23, 2023 16:45

perlinm added 6 commits September 23, 2023 11:58

requirements.py cleanup

e1a5beb

simplify can_connect_to_pypi use

9e973a3

more requirements cleanup

d93d1bc

minor cleanup of get_latest_version

69147e8

nit fix

559d174

more helpful warning

a0de635

perlinm added 4 commits September 23, 2023 22:05

return local version if the one on pypi is unavailable

bc09379

undo wrong formatting changes

5798674

undo wrong formatting changes

fe945e3

undo wrong formatting changes

c4d6098

perlinm commented Sep 24, 2023

View reviewed changes

perlinm requested a review from richrines1 September 24, 2023 03:11

perlinm self-assigned this Sep 24, 2023

perlinm mentioned this pull request Sep 25, 2023

Code hygiene and check script fixes jmlarson1/QFI-Opt#35

Merged

perlinm added 4 commits September 28, 2023 15:44

Merge branch 'main' into factor-out-checks

30038a0

update requirements

5d954bf

Merge branch 'main' into factor-out-checks

09954b5

update requirements

c8f5294

richrines1 reviewed Oct 2, 2023

View reviewed changes

perlinm and others added 6 commits October 2, 2023 11:59

Update checks-superstaq/pyproject.toml

34f03bf

Co-authored-by: richrines1 <85512171+richrines1@users.noreply.github.com>

gss[dev] --> checks-ss

ece44b0

Merge branch 'main' into factor-out-checks

b1a54ea

revert Apache 2 --> Apache-2.0

3b866af

Apache-2.0 it is

92bd25f

check --> checks

525309c

perlinm requested a review from richrines1 October 2, 2023 18:45

perlinm added 2 commits October 2, 2023 14:49

more check --> checks

315da2a

fix CI workflows

6535d99

richrines1 approved these changes Oct 2, 2023

View reviewed changes

Merge branch 'main' into factor-out-checks

477a2ad

perlinm merged commit 0a9f1eb into main Oct 2, 2023
16 checks passed

perlinm deleted the factor-out-checks branch October 2, 2023 20:06

perlinm mentioned this pull request Oct 5, 2023

fix incorrect line in checks-superstaq/pyproject.toml #805

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Factor out `checks-superstaq` #789

Factor out `checks-superstaq` #789

perlinm commented Sep 23, 2023 •

edited

Loading

perlinm commented Sep 23, 2023 •

edited

Loading

perlinm Sep 23, 2023 •

edited

Loading

richrines1 Sep 23, 2023

perlinm Sep 23, 2023

richrines1 Sep 23, 2023

perlinm commented Sep 23, 2023 •

edited

Loading

perlinm Sep 24, 2023 •

edited

Loading

perlinm commented Sep 24, 2023 •

edited

Loading

richrines1 left a comment

richrines1 Oct 2, 2023

perlinm Oct 2, 2023 •

edited

Loading

richrines1 Oct 2, 2023

perlinm Oct 2, 2023 •

edited

Loading

perlinm Oct 2, 2023

richrines1 Oct 2, 2023

perlinm Oct 2, 2023 •

edited

Loading

perlinm Oct 2, 2023 •

edited

Loading

richrines1 Oct 2, 2023

richrines1 left a comment

perlinm commented Oct 2, 2023 •

edited

Loading

Factor out checks-superstaq #789

Factor out checks-superstaq #789

Conversation

perlinm commented Sep 23, 2023 • edited Loading

perlinm commented Sep 23, 2023 • edited Loading

perlinm Sep 23, 2023 • edited Loading

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

perlinm commented Sep 23, 2023 • edited Loading

perlinm Sep 24, 2023 • edited Loading

Choose a reason for hiding this comment

perlinm commented Sep 24, 2023 • edited Loading

richrines1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

perlinm Oct 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

perlinm Oct 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

perlinm Oct 2, 2023 • edited Loading

Choose a reason for hiding this comment

perlinm Oct 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richrines1 left a comment

Choose a reason for hiding this comment

perlinm commented Oct 2, 2023 • edited Loading

Factor out `checks-superstaq` #789

Factor out `checks-superstaq` #789

perlinm commented Sep 23, 2023 •

edited

Loading

perlinm commented Sep 23, 2023 •

edited

Loading

perlinm Sep 23, 2023 •

edited

Loading

perlinm commented Sep 23, 2023 •

edited

Loading

perlinm Sep 24, 2023 •

edited

Loading

perlinm commented Sep 24, 2023 •

edited

Loading

perlinm Oct 2, 2023 •

edited

Loading

perlinm Oct 2, 2023 •

edited

Loading

perlinm Oct 2, 2023 •

edited

Loading

perlinm Oct 2, 2023 •

edited

Loading

perlinm commented Oct 2, 2023 •

edited

Loading