Python Packaging

[hoseok-lee]

Hi Leo (and GW)!

ClumPyCells is a wonderful tool in the spatial analysis ecosystem, but I personally found a little bit of friction while working with the package. I took the creative liberty to make it into a proper Python package, but feel free to take administration in making certain changes. In fact, the main reason why I wanted to package it in the first place was because I wanted to use it for my own analysis. Before editing or merging the PR, I highly recommend testing the package by re-running your analysis (as I was unable to import this package, see comments below).

Comments

1. The installation sequence is now different. It is noted in the updated README.md, but you need to install ClumPyCells onto a Python environment through pip install . from the base directory. Once you publish to PyPi, you can change the command to pip install ClumPyCells
2. I was unable to actually import the package as there is a customized file import for a config.json in Analysis/metadata.py, which may pose issues for future users (since they don't have access to that file). I'm sure you have noted it already, but just commenting it here to remind you.
3. I've also added a GNU General Public License (GW's favourite).

Publishing on PyPi

If you haven't worked with the PyPi ecosystem before, I recommend following these tutorial steps. It is extremely simple, as you just need to

1. Create a PyPi account
2. Build the distribution with python -m build
3. Upload the package with twine upload --repository pypi dist/*