Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.25 KB

Defense Finder

A cli utility enabling systematic search of all anti-phage systems in proteins using MacSyData and Mdm labs models.

Structure

cli

The cli logic, using click.

defense-finder

The defense finder logic, calling macsydata with the models.

updater

Updates the defense-finder models. Called during post-install and anytime later on.

Publishing

A Github action is setup to trigger a package release everytime a tagged commit is pushed.

Note that you don't need to publish defense-finder everytime the models change: only changes in this repository are relevant.

Here are the steps to follow in order to publish defense-finder:

  • find the current version in defense_finder_cli/_version.py
  • get a new version number according to semantic versionning
  • update the version un defense_finder_cli/_version.py
  • commit this change, and tag the commit with git tag -a v<your version number> -m '<your version number> <an optional message>'
  • push your commits to master
  • run git push origin v<your version> to sync the tags
  • wait for the Github actions task to complete.
  • all set! install the new version with pip install mdmparis-defense-finder==v<your-version>