Added brief introduction to using external packages #29
Conversation
README.md
Outdated
| load("@dbx_build_tools//build_tools/py:py.bzl", "dbx_py_pypi_piplib") | ||
|
|
||
| dbx_py_pypi_piplib( | ||
| name = "some_library", |
There was a problem hiding this comment.
There's a typo here. Maybe instead, introduce another_library that depends on some_library. That will cut down on needing to duplicate.
There was a problem hiding this comment.
My apologies for the typo - I entirely agree with the suggestion of simplifying the instructions by using another_library as the dependent package rather than the dependency.
README.md
Outdated
| Consider that `some_library` requires `some_setup_library`. Then, following the previous steps, you can write | ||
|
|
||
| ``` | ||
| # [project_root]/pip/some_setup_library/BUILD: |
There was a problem hiding this comment.
Again cut this, define another_library below and have it setup_requires on some_library.
|
I agree with the above comments and have updated my PR with the requested changes. I am likewise happy to address any further concerns. |
|
|
Partially addresses #27, and related to #5
I'm a new user of this project, and I found it rather difficult to understand how external packages were used. After finding issue #5, and seeing some explanation, as well as with help from @jsharpe on the Bazel/Python slack channel, I believe that I understand the process.
I figured that that I should assist by adding some instructions to
README.mdI don't know if my approach is the intended approach, so I'm happy to make any changes (or for you to make any changes) to suit the intended use. Either way, I think such an explanation is vital for newcomers to utilize this project.