Metadata-Version: 2.1
Name: mdmparis-defense-finder
Version: 0.0.4
Summary: Defense Finder: allow for a systematic search of all known anti-phage systems.
Home-page: https://github.com/mdmparis/defense-finder
Author: Alexandre Hervé
Author-email: alexandreherve@protonmail.com
License: GPLv3
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: macsyfinder
Requires-Dist: click

# 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)[https://github.com/mdmparis/defense-finder/actions] 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 pertinent.

Here are the steps to follow in order to publish defense-finder:
- find the current version in the `setup` function of `setup.py`.
- get a new version number according to (semantic versionning)[https://semver.org/]
- update the version un `setup.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!


