calebweinreb / SNUB

MIT License
24 stars 4 forks source link

[Major] package deployment via pip #13

Closed vigji closed 8 months ago

vigji commented 10 months ago

Since there are no difficult dependencies in the project (and no environment file necessary as a result), I would highly recommend distribute the package via PyPI/pip, so that it can be more easily installed and kept updated by all users.

niksirbi commented 9 months ago

Agreed, deployment on pip would be feasible and could enable a one-line install (pip install snub) on most platforms. It's worth pursuing sooner rather than later since it will make SNUB much more accessible.

Once the first release is deployed, update releases can be automated via GitHub Actions. Some example action workflows can be found here.

calebweinreb commented 9 months ago

SNUB is now available via pip https://pypi.org/project/systems-neuro-browser/

The name snub was already taken on PyPI, so to install, users will have to run pip install systems-neuro-browser although they will still import snub in python and run snub from the command line.

I chose not to implement automatic updates (e.g. via GitHub Actions) since I will remain the main developer for the foreseeable future and can perform the updates manually.

niksirbi commented 9 months ago

I can confirm that pip install systems-neuro-browser works! Thanks.