search

MetOffice / cube_helper

A Python module, for easier manipulation of Cubes with Iris
https://cube-helper.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
2 stars 4 forks source link

Consider if additional ways to install cube_helper are required #31

Closed jonseddon closed 4 years ago

jonseddon commented 4 years ago

A setup.py (or similar) may make it easier for users to install cube_helper in addition to just setting PYTHONPATH.

jonseddon commented 4 years ago

Hi @TheElectricFlock, I've had a chat with the SciTools team about this. I think that it would be really convenient for users if they can pip install cube_helper. For other users, and also internally, it would be good to also have it in Conda using the conda-forge channel. The easiest way to do this is to add it to PyPI so that pip works. Conda-forge can then grab a copy from PyPI.

There's a tutorial on getting packages into PyPI at https://packaging.python.org/tutorials/packaging-projects/. It's also worth checking the slides from the internal packaging talk as a setup,cfg or pyproject.toml file may be easier or more appropriate.

For getting the PyPI project to conda-forge then have a look at https://docs.conda.io/projects/conda-build/en/latest/user-guide/tutorials/build-pkgs-skeleton.html and SciTools said that there's a good example of one of these at https://github.com/conda-forge/dask-jobqueue-feedstock/blob/master/recipe/meta.yaml.

When this is all done could you also update the internal deployment instructions so that I know what I'm doing as well please?

jonseddon commented 4 years ago

Now available on conda-forge too: https://anaconda.org/conda-forge/cube_helper

Documentation is freely available at: https://cube-helper.readthedocs.io/