Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev environment using devenv #48

Merged
merged 2 commits into from
Jul 28, 2023
Merged

Dev environment using devenv #48

merged 2 commits into from
Jul 28, 2023

Conversation

aborgna-q
Copy link
Collaborator

  • Updates devenv for python development
  • Adds a setup guide in DEVELOPMENT.md for both devenv and manual install
  • Updates README and LICENCE

devenv shell is quite noisy currently due to it running pip install -r requirements.txt each time it's initialized.
I don't see how to avoid that without making a PR.

- Includes a setup guide in DEVELOPMENT.md
@aborgna-q aborgna-q requested a review from ss2165 July 27, 2023 16:16
@aborgna-q
Copy link
Collaborator Author

I have no idea how to do Nix, but I hope this works.

@@ -0,0 +1,31 @@
#!/bin/sh
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file might interfere with devenv pre commit hooks

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a template for the manual setup. I think it makes sense to put it in the .github dir, but could go anywhere else.

From what I understand, nix will override it when inside a devenv so there should be no interference. (There it also says that .pre-commit-config.yaml shouldn't be in the repo, so I'll remove it).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep that all makes sense

README.md Outdated
You will need rust >= 1.67.
You will need access to the [tket-json-rs repository](https://github.com/CQCL/tket-json-rs) as that is a git dependency.
[![build_status][]](https://github.com/CQCL-DEV/tket2/actions)
[![msrv][]](https://github.com/CQCL-DEV/tket2)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this the msrv link

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just to make the badge clickable. I'll drop the link.

@aborgna-q aborgna-q requested a review from ss2165 July 28, 2023 14:38
@aborgna-q aborgna-q merged commit 5722bb8 into main Jul 28, 2023
5 checks passed
@aborgna-q aborgna-q deleted the chore/devenv branch July 28, 2023 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants