{"id":42522608,"url":"https://github.com/nmdp-bioinformatics/seq-ann","last_synced_at":"2026-01-28T15:34:06.765Z","repository":{"id":57465701,"uuid":"109736463","full_name":"nmdp-bioinformatics/seq-ann","owner":"nmdp-bioinformatics","description":"Python package for doing fast and accurate sequence annotation","archived":false,"fork":false,"pushed_at":"2023-05-22T22:28:03.000Z","size":23535,"stargazers_count":5,"open_issues_count":7,"forks_count":8,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-09-02T07:20:07.743Z","etag":null,"topics":["bioinformatics","gfe","hla","hla-typing","ngs","sequence-analysis"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nmdp-bioinformatics.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-11-06T18:57:31.000Z","updated_at":"2023-09-12T14:52:32.000Z","dependencies_parsed_at":"2023-07-13T16:52:56.063Z","dependency_job_id":null,"html_url":"https://github.com/nmdp-bioinformatics/seq-ann","commit_stats":{"total_commits":153,"total_committers":5,"mean_commits":30.6,"dds":"0.20261437908496727","last_synced_commit":"d46c6bcaebe095127be227ef3f3f39e86c1ee4c3"},"previous_names":["nmdp-bioinformatics/seqann"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/nmdp-bioinformatics/seq-ann","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmdp-bioinformatics%2Fseq-ann","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmdp-bioinformatics%2Fseq-ann/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmdp-bioinformatics%2Fseq-ann/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmdp-bioinformatics%2Fseq-ann/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nmdp-bioinformatics","download_url":"https://codeload.github.com/nmdp-bioinformatics/seq-ann/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nmdp-bioinformatics%2Fseq-ann/sbom","scorecard":{"id":690885,"data":{"date":"2025-08-11","repo":{"name":"github.com/nmdp-bioinformatics/seq-ann","commit":"d46c6bcaebe095127be227ef3f3f39e86c1ee4c3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: COPYING:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: COPYING:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v9hf-5j83-6xpp","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2023-74 / GHSA-j8r2-6x86-q33q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.7 to python:3.7@sha256:eedf63967cdb57d8214db38ce21f105003ed4e4d0358f02bedc057341bcf92a0","Warn: pipCommand not pinned by hash: Dockerfile:11","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}}]},"last_synced_at":"2025-08-22T02:16:27.055Z","repository_id":57465701,"created_at":"2025-08-22T02:16:27.056Z","updated_at":"2025-08-22T02:16:27.056Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28846349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T15:15:36.453Z","status":"ssl_error","status_checked_at":"2026-01-28T15:15:13.020Z","response_time":57,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bioinformatics","gfe","hla","hla-typing","ngs","sequence-analysis"],"created_at":"2026-01-28T15:34:06.706Z","updated_at":"2026-01-28T15:34:06.759Z","avatar_url":"https://github.com/nmdp-bioinformatics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===============================\nSeqAnn\n===============================\n\n\n.. image:: https://img.shields.io/travis/nmdp-bioinformatics/SeqAnn.svg\n        :target: https://travis-ci.org/nmdp-bioinformatics/SeqAnn\n\n.. image:: https://readthedocs.org/projects/seqann/badge/?version=latest\n        :target: https://seqann.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/nmdp-bioinformatics/SeqAnn/shield.svg\n     :target: https://pyup.io/repos/github/nmdp-bioinformatics/SeqAnn/\n     :alt: Updates\n\n.. image:: https://img.shields.io/pypi/v/seqann.svg\n        :target: https://pypi.python.org/pypi/seqann\n\n.. image:: https://coveralls.io/repos/github/nmdp-bioinformatics/SeqAnn/badge.svg?branch=master\n        :target: https://coveralls.io/github/nmdp-bioinformatics/SeqAnn?branch=master\n\n\nPython package for annotating gene features\n\n\n* Free software: LGPL 3.0\n* Documentation: https://seqann.readthedocs.io.\n* `Jupyter Notebook`_\n\n\nOverview\n---------\n\nThe ``seqann`` package allows \nusers to annotate gene features in consensus sequences. Annotations can be created by passing consensus sequences to the ``annotate`` method in the\n``BioSeqAnn`` class. No parameters are required when initalizing a ``BioSeqAnn`` class. However, annotations can be\ncreated significantly faster when using a BioSQL database. When a BioSQL database is not provided the lastest `hla.dat`_ file is downloaded and parsed.\nA BioSQL database containing all of IPD-IMGT/HLA is available on DockerHub_ and can be\nrun on any machine that has docker installed. \n\nInstall\n------------\n\n.. code-block:: shell\n    \n    pip install seq-ann\n\n\nParameters\n----------\n\nBelow are the list of parameters and the default values used when initalizing a ``BioSeqAnn`` object.\n\n.. table::\n    :widths: 10 10 10 50\n\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | Parameter   | Type              | Default | Description                                                                   |\n    +=============+===================+=========+===============================================================================+\n    | server      | ``BioSeqDatabase``| None    | A BioSQL database containing all of the sequence data from IPD-IMGT/HLA.      |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | dbversion   | ``str``           | Latest  | The IPD-IMGT/HLA or KIR database release.                                     |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | datfile     | ``str``           | None    | The IPD-IMGT/HLA or KIR dat file to use in place of the **server** parameter. |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | kir         | ``bool``          | False   | Flag for indicating the input sequences are from the KIR gene system.         |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | align       | ``bool``          | False   | Flag for producing the alignments along with the annotations.                 |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | verbose     | ``bool``          | False   | Flag for running in verbose mode.                                             |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | verbosity   | ``int``           | None    | Numerical value to indicate how verbose the output will be in verbose mode.   |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n    | debug       | ``Dict``          | None    | A dictionary containing a process names as the key and verbosity as the value |\n    +-------------+-------------------+---------+-------------------------------------------------------------------------------+\n\nUsage\n---------\n\nTo annotated a sequence initialize a new ``BioSeqAnn`` object and then pass the sequence to the\n``annotate`` method. The sequence must be a Biopython ``Seq``. The locus of the sequence is not required but it will improve the accuracy of the annotation.\n\n\n  The packages `ncbi-blast+` and `clustalo` are required to be installed on your system.\n\n\n  Set variables to BioSQL host/port if using BioSQL.\n\n.. code-block:: shell\n\n    export BIOSQLHOST=\"localhost\"\n    export BIOSQLPORT=3306\n\n.. code-block:: python3\n\n    from seqann import BioSeqAnn\n    seqann = BioSeqAnn()\n    ann = seqann.annotate(sequence, \"HLA-A\")\n\n\nThe annotation of sequence can be done with or without providing a ``BioSeqDatabase``. To use a BioSQL database \ninitialize a ``BioSeqDatabase`` with the parameters that match the database you have running. If you are \nrunning the imgt_biosqldb from DockerHub_ then the following parameters we be the same. \n\n.. code-block:: python3\n\n    from seqann import BioSeqAnn\n    from BioSQL import BioSeqDatabase\n    server = BioSeqDatabase.open_database(driver=\"pymysql\", user=\"root\",\n                                          passwd=\"my-secret-pw\", host=\"localhost\",\n                                          db=\"bioseqdb\", port=3306)\n    seqann = BioSeqAnn(server=server)\n    ann = seqann.annotate(sequence, \"HLA-A\")\n\n\nYou may need to set environment variables: *BIOSQLHOST* (e.g. \"localhost\") and *BIOSQLPORT*  (e.g. 3306)  to your docker instance.\n\n\nAnnotations\n------------\n\n.. code-block:: shell\n\n            {\n                 'complete_annotation': True,\n                 'annotation': {'exon_1': SeqRecord(seq=Seq('AGAGACTCTCCCG', SingleLetterAlphabet()), id='HLA:HLA00630', name='HLA:HLA00630', description='HLA:HLA00630 DQB1*03:04:01 597 bp', dbxrefs=[]),\n                                'exon_2': SeqRecord(seq=Seq('AGGATTTCGTGTACCAGTTTAAGGCCATGTGCTACTTCACCAACGGGACGGAGC...GAG', SingleLetterAlphabet()), id='HLA:HLA00630', name='HLA:HLA00630', description='HLA:HLA00630 DQB1*03:04:01 597 bp', dbxrefs=[]),\n                                'exon_3': SeqRecord(seq=Seq('TGGAGCCCACAGTGACCATCTCCCCATCCAGGACAGAGGCCCTCAACCACCACA...ATG', SingleLetterAlphabet()), id='HLA:HLA00630', name='\u003cunknown name\u003e', description='HLA:HLA00630', dbxrefs=[])},\n                 'features': {'exon_1': SeqFeature(FeatureLocation(ExactPosition(0), ExactPosition(13), strand=1), type='exon_1'),\n                              'exon_2': SeqFeature(FeatureLocation(ExactPosition(13), ExactPosition(283), strand=1), type='exon_2')\n                              'exon_3': SeqFeature(FeatureLocation(ExactPosition(283), ExactPosition(503), strand=1), type='exon_3')},\n                 'method': 'nt_search and clustalo',\n                 'gfe': 'HLA-Aw2-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-4',\n                 'seq': SeqRecord(seq=Seq('AGAGACTCTCCCGAGGATTTCGTGTACCAGTTTAAGGCCATGTGCTACTTCACC...ATG', SingleLetterAlphabet()), id='HLA:HLA00630', name='HLA:HLA00630', description='HLA:HLA00630 DQB1*03:04:01 597 bp', dbxrefs=[])\n            }\n\n\nOnce a sequence has been annotated the gene features and their corresponding sequences are available in the returned ``Annotation`` object. If a full\nannotation is not able to be produced then nothing will be returned. Below is an example showing how the features can be accessed and printed out.\n\n.. code-block:: python3\n\n    ann = seqann.annotate(sequence, \"HLA-A\")\n    for feat in ann.annotation:\n        print(feat, ann.gfe, str(ann.annotation[feat].seq), sep=\"\\t\")\n\n\n\nDependencies\n------------\n* `Clustal Omega`_ 1.2.0 or higher\n* `Python 3.6`_\n* blastn_\n\n.. _DockerHub: https://hub.docker.com/r/nmdpbioinformatics/imgt_biosqldb/\n.. _`GitHub page`: http://google.com\n.. _`hla.dat`: https://github.com/ANHIG/IMGTHLA\n.. _`Python 3.6`: https://www.python.org/downloads\n.. _`Clustal Omega`: http://www.clustal.org/omega/\n.. _blastn: https://blast.ncbi.nlm.nih.gov/Blast.cgi?PAGE_TYPE=BlastDocs\u0026DOC_TYPE=Download\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n.. _`Jupyter Notebook`: https://github.com/nmdp-bioinformatics/SeqAnn/blob/master/notebook/Examples.ipynb\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnmdp-bioinformatics%2Fseq-ann","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnmdp-bioinformatics%2Fseq-ann","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnmdp-bioinformatics%2Fseq-ann/lists"}