search

somexlab / fastddm

Python library for Differential Dynamic Microscopy analysis
https://fastddm.readthedocs.io/
GNU General Public License v3.0
3 stars 0 forks source link

PyPI release #205

Closed enrico-lattuada closed 5 months ago

enrico-lattuada commented 5 months ago

This PR implements the changes needed to release the package on PyPI.

Closes issue #7

enrico-lattuada commented 5 months ago

I tried manually uploading the source distribution to TestPyPI (using versions from v0.0.0 to v0.0.4). I tested it and it works on different platforms and environments.

This is no different than downloading and installing the package from the repository, but it allows us to run tests before the final release to PyPI.

I added a workflow that should do the same. Currently, it runs only when a new release is published.

In the next future, we should:

enrico-lattuada commented 5 months ago

Currently, we have a source distribution available on TestPyPI. The wheels will be addressed in the next release. The installation process works as described in the Build from source guide, except that the package is downloaded from TestPyPI and not from GitHub.

To install from TestPyPI, run the following command:

python3 -m pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ fastddm

If one wants to test the installation multiple times with different options, please uninstall the package and clear the cache running the following commands:

python3 -m pip uninstall fastddm
python3 -m pip cache remove fastddm