search

PMEAL / porespy

A set of tools for characterizing and analying 3D images of porous materials
https://porespy.org
MIT License
309 stars 100 forks source link

python version on porespy.org says 3.6+ supported but github says 3.7+ #431

Closed TomTranter closed 3 years ago

TomTranter commented 3 years ago

A student of mine tried running in 3.6 and couldn't import. Probably want to update the website. Thanks

jgostick commented 3 years ago

I've seen some packages have badges that list the compatible python versions...might be helpful.

ma-sadeghi commented 3 years ago

It seems that adding a badge is as easy as generating a link using this website: https://shields.io/category/platform-support It only requires defining supported Python versions in setup.py as:

classifiers =
    Programming Language :: Python
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3 :: Only
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9

Also, it won't generate a badge until the next release (it looks up pypi for such info).

ma-sadeghi commented 3 years ago

I just added the OS and Python version description to setup.py, but it won't appear until our next release.

TODO: Before the next release, make sure to add the badge to README. TODO: also, tidy up setup.py using https://setuptools.readthedocs.io/en/latest/userguide/package_discovery.html

jgostick commented 3 years ago

This is how a badge is added:

[![Pyversions](https://img.shields.io/pypi/pyversions/porespy.svg?style=flat-square&label=Python%20Versions)](https://pypi.python.org/pypi/porespy)

But it doesn't seem to work for us:

Pyversions

If you put another package it works:

Pyversions

jgostick commented 3 years ago

This has been added to the readme in the new_examples branch