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.

Sign up for GitHub

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

Jump to bottom

[DOC] document how to do an editable install (for Python developers) #24

Closed
grlee77 opened this issue May 9, 2021 · 0 comments · Fixed by #30
Closed

[DOC] document how to do an editable install (for Python developers) #24

grlee77 opened this issue May 9, 2021 · 0 comments · Fixed by #30
Labels
doc Improvements or additions to documentation

Comments

@grlee77
Copy link
Contributor

grlee77 commented May 9, 2021

Report needed documentation

Report needed documentation

It would be useful to expand the contributor documentation to explain how the python package can be installed as an "editable install".

When I tried a naive pip install -e . -v call from within the python/cucim folder where setup.py is contained, this runs fine, but I am unable to import the package. I think the issue is that the cucim module folder is within a src subfolder rather than directly in the folder containing setup.py.

Describe the documentation you'd like
A workaround that fixes it for me, it to add the following to the setup.cfg:

[egg_info]
egg_base = src

which causes the cucim.egg-info folder to get placed into the src subfolder rather than in the same folder as setup.py itself.

Steps taken to search for needed documentation
read CONTRIBUTING.md
@grlee77 grlee77 added the doc Improvements or additions to documentation label May 9, 2021
This was referenced May 9, 2021
Merged
Merged
rapids-bot bot pushed a commit that referenced this issue May 11, 2021
@grlee77
add egg_info section to setup.py for editable installs (#26)
096cc79 
See #24

This PR adds an `egg_info` section to our `setup.cfg` so that editable installs via `pip install -e . ` work.

Authors:
  - Gregory R. Lee (https://github.com/grlee77)

Approvers:
  - Benjamin Zaitlen (https://github.com/quasiben)

URL: #26
rapids-bot bot pushed a commit that referenced this issue May 11, 2021
@grlee77
fix isort on CI (#28)
57179b8 
I looks like `isort` checks have not been running on CI due to an incorrect path in a CI script. The following shows up in CI logs:
```
/opt/conda/envs/rapids/lib/python3.7/site-packages/isort/main.py:104: UserWarning: Unable to parse file python due to [Errno 2] No such file or directory: '/workspace/python/cucim/python'

  warn(f"Unable to parse file {file_name} due to {error}")
```

The first commit here fixes that. I then changed `force_single_line` to False to minimize the amount of changes when rerunning `isort` on the existing code base (see #24). Let me know if we need to switch to `force_single_line = True` instead.

Authors:
  - Gregory R. Lee (https://github.com/grlee77)

Approvers:
  - AJ Schmidt (https://github.com/ajschmidt8)
  - Benjamin Zaitlen (https://github.com/quasiben)

URL: #28
@grlee77 grlee77 mentioned this issue May 12, 2021
Merged
@rapids-bot rapids-bot bot closed this as completed in #30 May 12, 2021
rapids-bot bot pushed a commit that referenced this issue May 12, 2021
@grlee77
Document editable install of the Python source (#30)
da33266 
closes #24

This is basically just the standard procedure now that the `setup.cfg` change in #26 was merged, but possibly still worth documenting?

Authors:
  - Gregory R. Lee (https://github.com/grlee77)

Approvers:
  - https://github.com/jakirkham

URL: #30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document editable install of the Python source grlee77/cucim
1 participant
@grlee77