{"id":16636888,"url":"https://github.com/widdowquinn/ncfp","last_synced_at":"2025-06-11T07:32:47.061Z","repository":{"id":29145785,"uuid":"108148887","full_name":"widdowquinn/ncfp","owner":"widdowquinn","description":"Program and package that retrieves nucleotide coding sequences from NCBI that correspond to a set of input protein sequences.","archived":false,"fork":false,"pushed_at":"2024-06-27T07:58:43.000Z","size":561,"stargazers_count":3,"open_issues_count":11,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-05-21T03:52:15.522Z","etag":null,"topics":["backtranslation","bioinformatics","ncbi","protein-to-nucleotide","sequence-to-sequence","uniprot"],"latest_commit_sha":null,"homepage":"https://widdowquinn.github.io/ncfp/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/widdowquinn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"docs/contributing.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-24T15:45:03.000Z","updated_at":"2024-06-27T07:58:46.000Z","dependencies_parsed_at":"2024-06-24T11:00:26.674Z","dependency_job_id":null,"html_url":"https://github.com/widdowquinn/ncfp","commit_stats":{"total_commits":201,"total_committers":5,"mean_commits":40.2,"dds":0.4925373134328358,"last_synced_commit":"5e70c9ce80e1ccaade29532ebb8c9111fa91efdd"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdowquinn%2Fncfp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdowquinn%2Fncfp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdowquinn%2Fncfp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdowquinn%2Fncfp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/widdowquinn","download_url":"https://codeload.github.com/widdowquinn/ncfp/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/widdowquinn%2Fncfp/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259222034,"owners_count":22824002,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["backtranslation","bioinformatics","ncbi","protein-to-nucleotide","sequence-to-sequence","uniprot"],"created_at":"2024-10-12T06:23:15.458Z","updated_at":"2025-06-11T07:32:47.002Z","avatar_url":"https://github.com/widdowquinn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# README.md - `ncfp`\n\nThis repository contains code for a script that identifies and writes the corresponding nucleotide sequences for each protein in an input multiple sequence file to be used, for example, in backthreading coding sequences onto protein alignments for phylogenetic analyses. `ncfp` uses the NCBI accession or UniProt gene name (as appropriate) to identify source nucleotide sequences in the NCBI databases, download them, and write them to a file.\n\n![macOS Python 3.11 build](https://github.com/widdowquinn/ncfp/actions/workflows/build-macos.yaml/badge.svg)\n![Linux Python 3.11 build](https://github.com/widdowquinn/ncfp/actions/workflows/build-linux.yaml/badge.svg)\n[![Codacy Coverage Badge](https://app.codacy.com/project/badge/Coverage/99a037e5eb2c4ae48e27e44c8974a3f8)](https://app.codacy.com/gh/widdowquinn/ncfp/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_coverage)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/99a037e5eb2c4ae48e27e44c8974a3f8)](https://www.codacy.com/manual/widdowquinn/ncfp?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=widdowquinn/ncfp\u0026amp;utm_campaign=Badge_Grade)\n[![CodeFactor](https://www.codefactor.io/repository/github/widdowquinn/ncfp/badge)](https://www.codefactor.io/repository/github/widdowquinn/ncfp)\n[![ncfp documentation](https://readthedocs.org/projects/ncfp/badge/?version=latest)](https://ncfp.readthedocs.io/en/latest/?badge=latest)\n\n[![ncfp PyPi version](https://img.shields.io/pypi/v/ncfp \"PyPI version\")](https://pypi.python.org/pypi/ncfp)\n[![ncfp licence](https://img.shields.io/pypi/l/ncfp \"PyPI licence\")](https://github.com/widdowquinn/ncfp/blob/master/LICENSE)\n[![ncfp PyPi version](https://img.shields.io/pypi/format/ncfp \"PyPI format\")](https://pypi.python.org/pypi/ncfp)\n[![ncfp PyPi version](https://img.shields.io/pypi/pyversions/ncfp \"Python versions\")](https://pypi.python.org/pypi/ncfp)\n[![ncfp PyPi version](https://img.shields.io/pypi/dm/ncfp \"PyPI downloads\")](https://pypi.python.org/pypi/ncfp)\n\n[![Anaconda-Server Badge](https://anaconda.org/bioconda/ncfp/badges/version.svg)](https://anaconda.org/bioconda/ncfp)\n[![Anaconda-Server Badge](https://anaconda.org/bioconda/ncfp/badges/latest_release_date.svg)](https://anaconda.org/bioconda/ncfp)\n\n[![Anaconda-Server Badge](https://anaconda.org/bioconda/ncfp/badges/downloads.svg)](https://anaconda.org/bioconda/ncfp)\n[![Anaconda-Server Badge](https://anaconda.org/bioconda/ncfp/badges/platforms.svg)](https://anaconda.org/bioconda/ncfp)\n\n[![codecov](https://codecov.io/github/widdowquinn/ncfp/graph/badge.svg?token=BIQKi7zUig)](https://codecov.io/github/widdowquinn/ncfp)\n![CodeCov coverage plot](https://codecov.io/github/widdowquinn/ncfp/graphs/icicle.svg?token=BIQKi7zUig)\n\n## Quickstart: `ncfp` at the command-line\n\nProviding an input file of protein sequences as `\u003cINPUT\u003e.fasta`, and writing output to the directory `\u003cOUTPUT\u003e`, while specifying a user email to NCBI of `\u003cEMAIL\u003e` will generate two files: `\u003cOUTPUT\u003e/ncfp_aa.fasta` and `\u003cOUTPUT\u003e/ncfp_nt.fasta`.\n\n```bash\nncfp \u003cINPUT\u003e.fasta \u003cOUTPUT\u003e \u003cEMAIL\u003e\n```\n\nThe file `\u003cOUTPUT\u003e/ncfp_aa.fasta` contains the amino acid sequences for all input proteins for which a corresponding nucleotide coding sequence could be identified, in FASTA format.\n\nThe file `\u003cOUTPUT\u003e/ncfp_nt.fasta` contains nucleotide coding sequences, where they could be found, for all the input proteins, in FASTA format.\n\nAny input protein sequences for which a corresponding nucleotide sequence cannot be recovered, for any reason, are placed in the file `\u003cOUTPUT\u003e/skipped.fas`.\n\nTo find out more about what `ncfp` can do, try\n\n```bash\nncfp --help\n```\n\nat the command-line\n\n## Documentation\n\nFor more detailed information about `ncfp` as a program, or using the underlying `ncbi_cds_from_protein` Python module, please see the stable version documentation at \u003chttps://ncfp.readthedocs.io/en/stable/\u003e\n\n## License\n\nUnless otherwise indicated, all code is licensed under the MIT license and subject to the following agreement:\n\n    (c) The James Hutton Institute 2017-2019\n    (c) The University of Strathclyde 2019-2024\n    Author: Leighton Pritchard\n\n    Contact: leighton.pritchard@strath.ac.uk\n\n    Address:\n    Leighton Pritchard,\n    Strathclyde Institute for Pharmacy and Biomedical Sciences,\n    Cathedral Street,\n    Glasgow,\n    G4 0RE,\n    Scotland,\n    UK\n\nThe MIT License\n\nCopyright (c) 2017-2019 The James Hutton Institute\nCopyright (c) 2019-2024 The University of Strathclyde\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiddowquinn%2Fncfp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwiddowquinn%2Fncfp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiddowquinn%2Fncfp/lists"}