-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add uv dependencies #2
base: master
Are you sure you want to change the base?
Conversation
@@ -0,0 +1,13 @@ | |||
repos: | |||
- repo: https://github.com/astral-sh/ruff-pre-commit | |||
rev: v0.6.5 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
v 0.6.9 is available since last week. Do you want to keep the 0.6.5 version?
args: ["--fix"] | ||
# Formatter | ||
- id: ruff-format | ||
types_or: ["python"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to let it run on Jupyter notebooks or not?
@@ -6,8 +6,15 @@ | |||
Describe why your topic is important and what you want to share with your audience | |||
|
|||
## Requirements | |||
Do not forget to indicate Python version and any other tools | |||
+ add requirements.txt or conda.yml or docker image or Binder/Google Collab link | |||
PyLadies encourage the usage of [uv](https://astral.sh/blog/uv) for dependency management. You can get uv by running the following command in your shell: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rather add uv and ruff pre-commit here as a hard requirement with direct links to how to install them from the source docs.
|
||
After you have specified the python version, you can create a virtual environemnt with `uv venv` and add packages with `uv add <package>`. Before the workshop, you can generate a requirements.txt file by running `uv export > requirements.txt`. | ||
|
||
If you are not familiar with uv or are in a hurry, feel free to work with your familiar dependency management system and the PyLadies will handle the `pyproject.toml` for you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please move the rest of the info (lines 13-17 to the Usage)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really want to handle pyproject.toml for them?
5. At the tob of the notebook, runthe following code: | ||
```bash | ||
!cd ./name-of-repo | ||
!pip install -r requirements.txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be valid in case of pyproject.toml usage?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added structural comments to the Readme, a version question to pre-commit
No description provided.