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

[Feature] add details to setup python envs and unit test workflow #510

Open
mxochicale opened this issue Mar 3, 2025 · 3 comments
Open
Labels
enhancement New feature or request

Comments

@mxochicale
Copy link
Contributor

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Currently there is no contribution guideline nor python env to do dev work

@mxochicale
Copy link
Contributor Author

ERROR using new uv env

pip install -e .
Defaulting to user installation because normal site-packages is not writeable
Looking in indexes: https://pypi.org/simple, https://pypi.ngc.nvidia.com
Obtaining file:///home/mxochicale/Desktop/ucl/brainGlobe/repositories/brainglobe-atlasapi
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
ERROR: Project file:///home/mxochicale/Desktop/ucl/brainGlobe/repositories/brainglobe-atlasapi has a 'pyproject.toml' and its build backend is missing the 'build_editable' hook. Since it does not have a 'setup.py' nor a 'setup.cfg', it cannot be installed in editable mode. Consider using a build backend that supports PEP 660.

@stellaprins
Copy link
Contributor

This may have to do with the setuptools version (currently the requirements are set to <45).

See this comment on StackOverflow:

Note: To be able to do an editable installation to your user site (pip install -e --user), you need a system installed setuptools v62.0.0 or newer.

@adamltyson
Copy link
Member

The requirements are set to setuptools>=45, this seems to work fine with pip on my system (in a conda env).

mxochicale added a commit that referenced this issue Mar 3, 2025
* install pip -e .[dev] using conda and uv,
* reorganise and tidies contributions guidelines for this repo:
  * adds steps and also optional to verify commits and using ssh keys,
  * steps for atlas_scripts
  * reorganise main contributions with how, seek for help and adding atlas
* moves citations to the end of the README,
* Adds Stella Prins, Miguel Xochicale as authors of the packages
mxochicale added a commit that referenced this issue Mar 3, 2025
mxochicale added a commit that referenced this issue Mar 4, 2025
…t parts on how to contribute to main README #510
@mxochicale mxochicale changed the title [Feature] add contribution guideline with python env and unit test workflow [Feature] add details to setup python envs and unit test workflow Mar 4, 2025
mxochicale added a commit that referenced this issue Mar 4, 2025
mxochicale added a commit that referenced this issue Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants