Replacing requirement files and setup.py with pyproject.toml #70

robotAstray · 2023-06-04T17:45:41Z

Summary

This pull request aims to resolve issue 61. The requirement files and setup.py have been replaced with pyproject.toml.

Details and comments

The pyproject.toml in this repo is a template and contains the required fields. In addition, optional fields can be added according to the documentation found here.
To install pyproject.toml use the command python -m pip install path/to/pyproject.toml

…pe-template into main

CLAassistant · 2023-06-04T17:45:47Z

All committers have signed the CLA.

robotAstray · 2023-06-05T13:15:48Z

Hello @caleb-johnson, would you kindly have a look at my solution?
If there are any problems I will fix them.
Thank you

caleb-johnson

Thanks for this submission! Just a small comment.

...enotes/notes/replace-requirment-files-and-setup.py-with-pyproject.toml-4db05996dd99827c.yaml

pyproject.toml

garrison · 2023-06-05T14:03:56Z

I'm going to approve the workflow, but my guess is that the "minimum version tests" and "development version tests" will fail for the meantime. Right now, an improved, pyproject.toml-compatible version of these tests is at https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/main/tools/extremal-python-dependencies.py. I'd really like to spin that off into its own repository so it can be used in other projects without having code duplicated in all of them.

Co-authored-by: Jim Garrison <jim@garrison.cc>

robotAstray · 2023-06-05T16:06:54Z

I'm going to approve the workflow, but my guess is that the "minimum version tests" and "development version tests" will fail for the meantime. Right now, an improved, pyproject.toml-compatible version of these tests is at https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/main/tools/extremal-python-dependencies.py. I'd really like to spin that off into its own repository so it can be used in other projects without having code duplicated in all of them.

@garrison, yes, I agree. The checks will not pass because requirements.txt and setup.py have been replaced by pyproject.toml. Some of the checks are looking for the paths of the files I removed (i.e. requirments.txt and setup.py).

caleb-johnson

Looks great, thanks!

caleb-johnson · 2023-06-05T22:51:55Z

Ahh the CI was passing earlier, sorry I'm getting caught up now :)

Broken CI

robotAstray · 2023-06-06T13:36:07Z

@garrison should I re-add requirments.txt and setup.py to the repo just so the checks pass? The idea was to replace them so I removed them, but I can see without them the checks will not be successful.

garrison · 2023-06-06T17:18:29Z

I think it makes more sense just to remove the dev and min version test workflows for now.

With regards to setup.py, I think it makes sense to have a minimal one for other reasons. Something identical to https://github.com/Qiskit-Extensions/circuit-knitting-toolbox/blob/contributing.md/setup.py would suffice.

robotAstray · 2023-06-06T17:27:38Z

@garrison ok, that is done for you. Thank you.

setup.py

garrison · 2023-06-06T17:34:34Z

tox.ini is going to need some changes, too. Where you see

quantum-prototype-template/tox.ini

Lines 15 to 16 in fac25b3

    
           deps = -rrequirements.txt 
        
                  -rrequirements-dev.txt

replace with extras = dev

Might also be worth grepping the repository (e.g., git grep) to see if the requirements files are mentioned in any other places.

robotAstray · 2023-06-06T18:42:21Z

Aside for the dev and min version test workflows which I removed, the files containing requirement files are:
ecosystem.json with :

        "dependencies_files": [
           "requirements.txt",
           "requirements-dev.txt"
       ],

README.md (I commented out the two paragraphs about the dev and min version test workflows since the files have been removed).
file-map-and-description.md (I can fix this by adding a short description of pyproject.toml)

…s from README.md

coveralls · 2023-06-06T18:47:38Z

Pull Request Test Coverage Report for Build 5192209113

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 100.0%

Totals
Change from base Build 4898908272:	0.0%
Covered Lines:	14
Relevant Lines:	14

💛 - Coveralls

robotAstray · 2023-06-07T15:09:06Z

@garrison should I modify theecosystem.json dependencies_files entry? If so what should I replaced that part with?
https://github.com/robotAstray/quantum-prototype-template/blob/be40dfe47e8cf5eafc43e3b553feb1ffd617c20c/ecosystem.json

robotAstray · 2023-06-14T01:39:04Z

I just ran tox -elint from the root folder and I have this

$ tox -elint
lint: commands[0]> black --check .
lint: failed with black is not allowed, use allowlist_externals to allow it
  lint: FAIL code 1 (0.28 seconds)
  evaluation failed :( (1.58 seconds)

garrison · 2023-06-14T02:50:58Z

You will need extras = dev in the lint and black environments, too.

robotAstray · 2023-06-15T23:29:03Z

Hello @garrison we already have extrs = dev on line 15 in tox.ini . I guess when you refer to lint and black environments you are referring to the block [testenv:black] and [testenv:lint]? I have tried to add extras = dev to these blocks and I still get the same error.

garrison · 2023-06-15T23:43:17Z

What version of tox are you using? If below version 4, you might have to pass the -r flag to tox for it to re-create the environment.

robotAstray · 2023-06-15T23:56:29Z

@garrison, I am currently on version 4.6.0.

robotAstray · 2023-06-16T00:31:52Z

perhaps there is a problem with my system. I ran all the commands manually and it seems to me the checks all passed
Update: 16th June 02:39 (CEST): I have created a virtual environment and re-installed pyproject.toml. That resolved some of the issues.
I have added allowlist_externals = pylint, nbqa under [testenv:lint] to allow tox -elint to run correctly.
Update: 16th June 03:17 (CEST): I think I have resolved the problems related to this issue. Let me know if there is anything else to fix (or change). Thank you.

tox.ini

thank you! I understand. Co-authored-by: Jim Garrison <jim@garrison.cc>

garrison · 2023-06-29T12:55:57Z

docs/file-map-and-description.md

+<!-- - [requirements.txt](../requirements.txt) - list of required 3rd party packages to run your project.
 - [requirements-dev.txt](../requirements-dev.txt) - list of required 3rd party packages that are
  NOT required to run your project, but which might benefit developers. It can include specific test
-  libraries, style checks packages etc.
+  libraries, style checks packages etc. -->


Can you remove these lines containing requirements.txt and requirements-dev.txt? (since there is no chance in them coming back)

That has been resolved.

Can you double check? I think you removed a different commented region, actually, than this one in c3a3519. I was thinking it makes sense to keep the explanations in README.md commented out since (we hope) the development and minimum version tests will re-appear in a subsequent PR.

Hello @garrison you can check my last push a4a72f7 it contains the changes you requested.

I have also re-added the comment section I wrongly removed previously. Sorry about that.

docs/file-map-and-description.md

Co-authored-by: Jim Garrison <jim@garrison.cc>

* Update README.md adding comment section that was removed by mistake * Update README.md re-adding comment section * Update file-map-and-description.md removing comments referring to `requirments.txt`

garrison · 2023-06-29T19:14:50Z

Just one note for the future (don't worry about this here): typically it is customary to make pull requests from a new branch in your fork, rather than using main in your fork. Using main can sometimes make things confusing, particularly if you open up multiple PRs to the same repository.

docs/file-map-and-description.md

garrison

Thanks, this is looking very good to me. I appreciate the contribution!

Co-authored-by: Jim Garrison <jim@garrison.cc>

robotAstray · 2023-06-29T19:42:50Z

Just one note for the future (don't worry about this here): typically it is customary to make pull requests from a new branch in your fork, rather than using main in your fork. Using main can sometimes make things confusing, particularly if you open up multiple PRs to the same repository.

noted!

robotAstray added 8 commits June 4, 2023 16:21

first attempt to add pyproject.toml

4e05afa

tested pyproject.toml

be3b52d

remove unnecessary files

5eb8fa2

add realease notes

34ef426

add release notes

9271cb3

additional changes to pyproject.toml

8ab08fb

Merge branch 'main' of https://github.com/robotAstray/quantum-prototy…

b7327a3

…pe-template into main

improve style in pyproject.toml

4fd0fb8

caleb-johnson reviewed Jun 5, 2023

View reviewed changes

...enotes/notes/replace-requirment-files-and-setup.py-with-pyproject.toml-4db05996dd99827c.yaml Outdated Show resolved Hide resolved

removing release notes

dd99197

garrison reviewed Jun 5, 2023

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

Update pyproject.toml

3301b86

Co-authored-by: Jim Garrison <jim@garrison.cc>

caleb-johnson previously approved these changes Jun 5, 2023

View reviewed changes

minimal setup.py

af5c400

garrison reviewed Jun 6, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

robotAstray added 3 commits June 6, 2023 19:03

adding single trailing new line in setup.py

7bc9f62

replace requirement files on tox.ini with extras = dev

917b50a

removing the dev and min version test workflows

b0d1ba2

commenting out the paragraphs about dev and min version test workflow…

485bfaf

…s from README.md

added pyproject.toml description to file-map-and-description.md

be40dfe

Update tox.ini (#1)

0715093

garrison reviewed Jun 17, 2023

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

Update tox.ini

3f45195

thank you! I understand. Co-authored-by: Jim Garrison <jim@garrison.cc>

garrison reviewed Jun 29, 2023

View reviewed changes

docs/file-map-and-description.md Outdated Show resolved Hide resolved

robotAstray and others added 3 commits June 29, 2023 14:00

Update README.md (#2)

c3a3519

Update docs/file-map-and-description.md

304947d

Co-authored-by: Jim Garrison <jim@garrison.cc>

Fixing comment sections (#3)

a4a72f7

* Update README.md adding comment section that was removed by mistake * Update README.md re-adding comment section * Update file-map-and-description.md removing comments referring to `requirments.txt`

garrison reviewed Jun 29, 2023

View reviewed changes

docs/file-map-and-description.md Outdated Show resolved Hide resolved

garrison reviewed Jun 29, 2023

View reviewed changes

Update docs/file-map-and-description.md

1d4e9de

Co-authored-by: Jim Garrison <jim@garrison.cc>

garrison approved these changes Jun 29, 2023

View reviewed changes

garrison merged commit 48015c1 into qiskit-community:main Jun 29, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replacing requirement files and setup.py with pyproject.toml #70

Replacing requirement files and setup.py with pyproject.toml #70

robotAstray commented Jun 4, 2023 •

edited

Loading

CLAassistant commented Jun 4, 2023 •

edited

Loading

robotAstray commented Jun 5, 2023 •

edited

Loading

caleb-johnson left a comment

garrison commented Jun 5, 2023

robotAstray commented Jun 5, 2023

caleb-johnson left a comment

caleb-johnson commented Jun 5, 2023

robotAstray commented Jun 6, 2023

garrison commented Jun 6, 2023

robotAstray commented Jun 6, 2023

garrison commented Jun 6, 2023 •

edited

Loading

robotAstray commented Jun 6, 2023

coveralls commented Jun 6, 2023

robotAstray commented Jun 7, 2023 •

edited

Loading

robotAstray commented Jun 14, 2023 •

edited

Loading

garrison commented Jun 14, 2023

robotAstray commented Jun 15, 2023

garrison commented Jun 15, 2023

robotAstray commented Jun 15, 2023

robotAstray commented Jun 16, 2023 •

edited

Loading

garrison Jun 29, 2023

robotAstray Jun 29, 2023

garrison Jun 29, 2023 •

edited

Loading

robotAstray Jun 29, 2023

robotAstray Jun 29, 2023

garrison commented Jun 29, 2023

garrison left a comment

robotAstray commented Jun 29, 2023

Replacing requirement files and setup.py with pyproject.toml #70

Replacing requirement files and setup.py with pyproject.toml #70

Conversation

robotAstray commented Jun 4, 2023 • edited Loading

Summary

Details and comments

CLAassistant commented Jun 4, 2023 • edited Loading

robotAstray commented Jun 5, 2023 • edited Loading

caleb-johnson left a comment

Choose a reason for hiding this comment

garrison commented Jun 5, 2023

robotAstray commented Jun 5, 2023

caleb-johnson left a comment

Choose a reason for hiding this comment

caleb-johnson commented Jun 5, 2023

robotAstray commented Jun 6, 2023

garrison commented Jun 6, 2023

robotAstray commented Jun 6, 2023

garrison commented Jun 6, 2023 • edited Loading

robotAstray commented Jun 6, 2023

coveralls commented Jun 6, 2023

Pull Request Test Coverage Report for Build 5192209113

💛 - Coveralls

robotAstray commented Jun 7, 2023 • edited Loading

robotAstray commented Jun 14, 2023 • edited Loading

garrison commented Jun 14, 2023

robotAstray commented Jun 15, 2023

garrison commented Jun 15, 2023

robotAstray commented Jun 15, 2023

robotAstray commented Jun 16, 2023 • edited Loading

garrison Jun 29, 2023

Choose a reason for hiding this comment

robotAstray Jun 29, 2023

Choose a reason for hiding this comment

garrison Jun 29, 2023 • edited Loading

Choose a reason for hiding this comment

robotAstray Jun 29, 2023

Choose a reason for hiding this comment

robotAstray Jun 29, 2023

Choose a reason for hiding this comment

garrison commented Jun 29, 2023

garrison left a comment

Choose a reason for hiding this comment

robotAstray commented Jun 29, 2023

robotAstray commented Jun 4, 2023 •

edited

Loading

CLAassistant commented Jun 4, 2023 •

edited

Loading

robotAstray commented Jun 5, 2023 •

edited

Loading

garrison commented Jun 6, 2023 •

edited

Loading

robotAstray commented Jun 7, 2023 •

edited

Loading

robotAstray commented Jun 14, 2023 •

edited

Loading

robotAstray commented Jun 16, 2023 •

edited

Loading

garrison Jun 29, 2023 •

edited

Loading