search

phac-nml / sistr_cmd

SISTR (Salmonella In Silico Typing Resource) command-line tool
Apache License 2.0
25 stars 9 forks source link

Sistr/updates for release #40

Closed apetkau closed 5 years ago

apetkau commented 5 years ago

This makes a few fixes to the code before it is released in PyPI, mainly:

  1. Inclusion of database: I set everything up so that the database files will actually be packaged up into the Python package along with the code (by changing the MANIFEST.in file). The total package size, including the database files, is only around 50 MB when compressed, which is small enough to be stored by PyPI. This means that when someone installs SISTR, they don't then have to wait to download the database files (and avoids issues if our irida.corefacility.ca site goes down).
  2. Consistent license: I made the license to consistently be Apache 2.0 everywhere (it appeared as a mix of Apache and GPL before).

I've tested out this package on the test PyPI server (https://test.pypi.org/project/sistr-cmd/). If you want to install it yourself you can run:

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

Let me know what you think.

jrober84 commented 5 years ago

I tested the updated on my local machine and it works perfectly.