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

Building docs and running tests require install #6

Open
igoumiri opened this issue Jun 17, 2024 · 2 comments
Open

Building docs and running tests require install #6

igoumiri opened this issue Jun 17, 2024 · 2 comments
Labels
bug Something isn't working

Comments

@igoumiri
Copy link
Contributor

igoumiri commented Jun 17, 2024

Describe the bug
I'm not super familiar with Python projects but it seems very strange to me that the docs and tests reference the installed package rather that the local one.

To Reproduce
Steps to reproduce the behavior:

  1. modify a file in /ssapy
  2. build the docs or run unit tests
  3. notice that the docs/tests don't reflect your changes

The workaround is to run python setup.py build and python setup.py install before step 2 but that's time consuming and error prone (easy to forget).

Expected behavior
I would expect the docs/tests to reflect my changes.

Output
None

Desktop (please complete the following information):
NA

Additional context
Not sure if it's a consequence of using setup.py (deprecated) to build/install. We should probably migrate to pip either way.

@igoumiri igoumiri added the bug Something isn't working label Jun 17, 2024
@igoumiri igoumiri changed the title Building docs and running tests requires install Building docs and running tests require install Jun 17, 2024
@aperloff
Copy link
Member

We've been using the workaround for a while and I also suspect that it's needed because of how we use setup.py. We don't have a way to install a development version of SSAPy that references the local code rather than the installed version. I totally agree that we should migrate to pip. We just haven't had the person power to do that as of yet.

@SuperdoerTrav
Copy link
Collaborator

python setup.py develop used to work just fine for me to modify code in the environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants