alan-turing-institute / distinctipy

A lightweight package for generating visually distinct colours.
https://distinctipy.readthedocs.io/en/latest/
MIT License
237 stars 13 forks source link

Including test suite in pypi tarball #29

Open TheChymera opened 1 year ago

TheChymera commented 1 year ago

Would you be interested to include the tests in the pypi source tarball?

For packaging software it's often more reliable to download the sources from pypi, as it prohibits re-release, whereas on GitHub it's often possible for people to retroactively include changes without realizing that a lot of package managers will flare up at the checksum mismatch as it's identical to what might be a security problem.

Currently, if I do that, I won't be able to permit users to run the test suite and ascertain the functionality of the package:

[deco]/tmp/dispy ❱ wget https://github.com/alan-turing-institute/distinctipy/archive/refs/tags/v1.2.2.tar.gz
--2023-01-31 07:33:36--  https://github.com/alan-turing-institute/distinctipy/archive/refs/tags/v1.2.2.tar.gz
Resolving github.com... 140.82.113.3
Connecting to github.com|140.82.113.3|:443... connected.
HTTP request sent, awaiting response... 302 Found
Location: https://codeload.github.com/alan-turing-institute/distinctipy/tar.gz/refs/tags/v1.2.2 [following]
--2023-01-31 07:33:37--  https://codeload.github.com/alan-turing-institute/distinctipy/tar.gz/refs/tags/v1.2.2
Resolving codeload.github.com... 140.82.113.10
Connecting to codeload.github.com|140.82.113.10|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: unspecified [application/x-gzip]
Saving to: ‘v1.2.2.tar.gz’

v1.2.2.tar.gz                          [               <=>                                               ]   7.83M  2.54MB/s    in 3.1s

2023-01-31 07:33:40 (2.54 MB/s) - ‘v1.2.2.tar.gz’ saved [8215214]

[deco]/tmp/dispy ❱ tar xvf v1.2.2.tar.gz
distinctipy-1.2.2/
distinctipy-1.2.2/.flake8
distinctipy-1.2.2/.gitattributes
distinctipy-1.2.2/.github/
distinctipy-1.2.2/.github/workflows/
distinctipy-1.2.2/.github/workflows/pythonapp.yml
distinctipy-1.2.2/.github/workflows/pythonpublish.yml
distinctipy-1.2.2/.gitignore
distinctipy-1.2.2/.isort.cfg
distinctipy-1.2.2/LICENSE
distinctipy-1.2.2/README.md
distinctipy-1.2.2/distinctipy/
distinctipy-1.2.2/distinctipy/__init__.py
distinctipy-1.2.2/distinctipy/_colorsets_data.py
distinctipy-1.2.2/distinctipy/colorblind.py
distinctipy-1.2.2/distinctipy/colorsets.py
distinctipy-1.2.2/distinctipy/datasets/
distinctipy-1.2.2/distinctipy/datasets/LICENSE
distinctipy-1.2.2/distinctipy/datasets/a1.csv
distinctipy-1.2.2/distinctipy/datasets/a2.csv
distinctipy-1.2.2/distinctipy/datasets/a3.csv
distinctipy-1.2.2/distinctipy/datasets/b1.csv
distinctipy-1.2.2/distinctipy/datasets/balloons.png
distinctipy-1.2.2/distinctipy/datasets/flower.png
distinctipy-1.2.2/distinctipy/datasets/flowers.png
distinctipy-1.2.2/distinctipy/datasets/lights.png
distinctipy-1.2.2/distinctipy/datasets/powder.png
distinctipy-1.2.2/distinctipy/datasets/s1.csv
distinctipy-1.2.2/distinctipy/datasets/s2.csv
distinctipy-1.2.2/distinctipy/datasets/s3.csv
distinctipy-1.2.2/distinctipy/datasets/s4.csv
distinctipy-1.2.2/distinctipy/datasets/test.png
distinctipy-1.2.2/distinctipy/datasets/umbrellas.png
distinctipy-1.2.2/distinctipy/datasets/wall.png
distinctipy-1.2.2/distinctipy/distinctipy.py
distinctipy-1.2.2/distinctipy/examples.py
distinctipy-1.2.2/distinctipy_logo.png
distinctipy-1.2.2/docs/
distinctipy-1.2.2/docs/Makefile
distinctipy-1.2.2/docs/about.rst
distinctipy-1.2.2/docs/api.rst
distinctipy-1.2.2/docs/conf.py
distinctipy-1.2.2/docs/index.rst
distinctipy-1.2.2/docs/install.rst
distinctipy-1.2.2/docs/make.bat
distinctipy-1.2.2/docs/usage.ipynb
distinctipy-1.2.2/examples.ipynb
distinctipy-1.2.2/examples/
distinctipy-1.2.2/examples/36colours.png
distinctipy-1.2.2/examples/colourblind_clusters_normal.png
distinctipy-1.2.2/examples/colourblind_clusters_optimised.png
distinctipy-1.2.2/examples/colourblind_test_protanopia.png
distinctipy-1.2.2/examples/colourblind_tritanopia_normal.png
distinctipy-1.2.2/examples/colourblind_tritanopia_optimised.png
distinctipy-1.2.2/examples/compare_50clusters_nipy_spectral.png
distinctipy-1.2.2/examples/compare_64colours_tab20.png
distinctipy-1.2.2/examples/input_output.png
distinctipy-1.2.2/examples/pastel.png
distinctipy-1.2.2/examples/text_and_invert.png
distinctipy-1.2.2/requirements.txt
distinctipy-1.2.2/requirements/
distinctipy-1.2.2/requirements/docs.txt
distinctipy-1.2.2/requirements/optional.txt
distinctipy-1.2.2/requirements/runtime.txt
distinctipy-1.2.2/requirements/tests.txt
distinctipy-1.2.2/setup.py
distinctipy-1.2.2/tests/
distinctipy-1.2.2/tests/test_distinctipy.py
distinctipy-1.2.2/tests/test_examples.py
[deco]/tmp/dispy ❱ wget https://files.pythonhosted.org/packages/3c/57/da49e941e26d0063b5d59c730f324ca72b4a693bf37543ae15016d48e18f/distinctipy-1.2.2.tar.gz
--2023-01-31 07:34:07--  https://files.pythonhosted.org/packages/3c/57/da49e941e26d0063b5d59c730f324ca72b4a693bf37543ae15016d48e18f/distinctipy-1.2.2.tar.gz
Resolving files.pythonhosted.org... 151.101.1.63, 151.101.65.63, 151.101.129.63, ...
Connecting to files.pythonhosted.org|151.101.1.63|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 27664 (27K) [application/x-tar]
Saving to: ‘distinctipy-1.2.2.tar.gz’

distinctipy-1.2.2.tar.gz           100%[================================================================>]  27.02K  --.-KB/s    in 0.002s

2023-01-31 07:34:07 (15.5 MB/s) - ‘distinctipy-1.2.2.tar.gz’ saved [27664/27664]

[deco]/tmp/dispy ❱ tar xvf distinctipy-1.2.2.tar.gz
distinctipy-1.2.2/
distinctipy-1.2.2/LICENSE
distinctipy-1.2.2/PKG-INFO
distinctipy-1.2.2/README.md
distinctipy-1.2.2/distinctipy/
distinctipy-1.2.2/distinctipy/__init__.py
distinctipy-1.2.2/distinctipy/_colorsets_data.py
distinctipy-1.2.2/distinctipy/colorblind.py
distinctipy-1.2.2/distinctipy/colorsets.py
distinctipy-1.2.2/distinctipy/distinctipy.py
distinctipy-1.2.2/distinctipy/examples.py
distinctipy-1.2.2/distinctipy.egg-info/
distinctipy-1.2.2/distinctipy.egg-info/PKG-INFO
distinctipy-1.2.2/distinctipy.egg-info/SOURCES.txt
distinctipy-1.2.2/distinctipy.egg-info/dependency_links.txt
distinctipy-1.2.2/distinctipy.egg-info/requires.txt
distinctipy-1.2.2/distinctipy.egg-info/top_level.txt
distinctipy-1.2.2/setup.cfg
distinctipy-1.2.2/setup.py
jack89roberts commented 1 year ago

Hi @TheChymera , is this something you'd be interested in making a PR for? There's an actions workflow that builds and pushes the package in .github/workflows/pythonpublish.yml. Or if not I can plan to have a look at it, but not sure when I'll have time.