-
Notifications
You must be signed in to change notification settings - Fork 9
Dev environment setup #139
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
Dev environment setup #139
Conversation
anishdixit-uw
commented
Jun 28, 2023
- Added 2 new files: dev_setup.sh which contains python commands to install required packages and develop ooipy and verify_setup.py which confirms OOIPY installation and returns path
- Added instructions on the step by step process to run these files and setup the environment in docs/source/install_instructions.rst
updates: - [github.com/codespell-project/codespell: v2.2.4 → v2.2.5](codespell-project/codespell@v2.2.4...v2.2.5)
…ci-update-config [pre-commit.ci] pre-commit autoupdate
for more information, see https://pre-commit.ci
Alright, when following the instructions, when running dev_setup.sh I get this error:
Also, another small thing. This installs python 3.11, which we don't officially support with unit tests. There probably isn't any error, but it might be nice to add the 3.11 unit tests and the support for python 3.11 I guess |
that seems strange because in the .sh file, I have put in a command to run the setup.py file. I think the error is occuring because I am first running conda develop ooipy and then running setup.py. Let me change the order in which those commands are being run and then we can check if it works |
Alright yeah, changing the order fixed it in my environment |
Okay, I have committed the change with the swapped order here too |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, I think we're ready to merge.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could probably run verify_setup.py within the bash script.
And it might even be possible to check if the python path is the local directory within the python script, and then just print something like
'Development environment installation successful'
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anishdixit-uw, would you be able to add these changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@John-Ragland verify_setup.py already runs from within the bash script.
And it does print out the path of OOIPY installation, so is that what you are saying here or something different?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, could we change name lines for creating the environment to have the environment name be ooipy_dev?
conda create --name ooipy_dev
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@John-Ragland for now I assumed that the environment is already created, then the user clones the repo and then runs the bash script.
If we want to give in environment creation instructions ourselves, the documentation will have to be changed, so the new order would be:
- Clone repo
- Run bash script (env gets automatically created)
If this logic makes sense, I can make the changes, should be easily doable
Tagging the relevant issue #136 |