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

Add additional documentation to setting up python development #404

Closed
Smurphy000 opened this issue Aug 21, 2021 · 6 comments
Closed

Add additional documentation to setting up python development #404

Smurphy000 opened this issue Aug 21, 2021 · 6 comments
Labels
enhancement New feature or request

Comments

@Smurphy000
Copy link
Contributor

Description

Currently trying to setup the dev environment for python using maturin, however, based on the current documentation in the readme and looking for other sources, I can't seem to find a way to easily install the optional dependencies listed in the pyproject.toml file.

This began after I successfully ran make develop but then tried running make unit-test where I release pytest was under optional dependencies and no optional dependencies were install with the make develop command

Use Case
Quickly get the dev environment setup including testing, formatting, and other optional dependencies

@Smurphy000 Smurphy000 added the enhancement New feature or request label Aug 21, 2021
@Smurphy000
Copy link
Contributor Author

PyO3/maturin#604

@Smurphy000
Copy link
Contributor Author

From linked issue, I overcame the current concern using make build followed by pip install <path-to-wheel>/example.whl[devel] or other forms could work. If that is the preferred way for now I could add that to the readme

@houqp
Copy link
Member

houqp commented Aug 21, 2021

Yes, this is how I setup my local env as well. Thanks for helping with documentation.

@fvaleye
Copy link
Collaborator

fvaleye commented Aug 21, 2021

From linked issue, I overcame the current concern using make build followed by pip install <path-to-wheel>/example.whl[devel] or other forms could work. If that is the preferred way for now I could add that to the readme

Yes, good idea! The README.md needs to be updated to include the optional dependencies for the local environment. You could take a look at the Python build Github workflow file: https://github.com/delta-io/delta-rs/blob/main/.github/workflows/python_build.yml#L58. Thanks for helping!

@Smurphy000
Copy link
Contributor Author

@fvaleye are we good to close this?

@fvaleye
Copy link
Collaborator

fvaleye commented Aug 23, 2021

@fvaleye are we good to close this?

Yes, let me do this for you!

@fvaleye fvaleye closed this as completed Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants