Open Source Community Development

Overview

PhageScanner is and always will be an open-source tool. To add to this tool, please review the following information provided in this guide.

Notes

1. Database configuration names must match those in in the DatabaseAdapterNames Enum. If you want to create a new database adapter, make sure to add the name to the DatabaseAdapterNames enum. In addition, you must ensure these names match the configuration file, or the database query will be ignored.
2. Each "pipeline", as specified in the Pipelines.py file, is tied to a specific configuration class that is directly coupled with a particular configuration file. If you want to change the names for a particular pipeline, you must update the corresponding class. This design pattern allows for easily changing the configuration dependencies for a particular pipeline.
3. Make sure the configuration files have names that are one word - without spaces.