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

CONTRIBUTING: Switching pip install to use local install #136

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rm-star
Copy link
Contributor

@rm-star rm-star commented Aug 2, 2022

Problem

The current developer install is using
pip setup.py
which creates a distributable installation. If a developer makes changes
to code then they essentailly need to build and reinstall the package

Solution

If pip install -e . is used then the local site packages will
create a symbolic link which means developers can make cahnges locally
and they will automatically picked up.
It also has the bonus of installing dependencies automatically


A good case for this install format is made here https://stackoverflow.com/questions/42609943/what-is-the-use-case-for-pip-install-e

I am able to test this on linux but not Mac or Windows, though python should
operate in the same way where ever it runs

rm-star added 2 commits August 2, 2022 17:32
Problem

The current developer install is using
pip setup.py
which creates a distributable installation. If a developer makes changes
to code then they essentailly need to build and reinstall the package

Solution

If pip install -e . is used then the local site packages will
create a symbolic link which means developers can make cahnges locally
and they will automatically picked up.
It also has the bonus of installing dependencies automatically
happening during a build and debug any issues quicker
@rm-star
Copy link
Contributor Author

rm-star commented Aug 3, 2022

I should also say that the -e in the install command means that it is an editable install. I think that helps explain it a bit better

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.

1 participant