protein-quest 0.3.0__py3-none-any.whl

protein_quest-0.3.0.dist-info/METADATA

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: protein_quest
+Version: 0.3.0
+Summary: Search/retrieve/filter proteins and protein structures
+Project-URL: Homepage, https://github.com/haddocking/protein-quest
+Project-URL: Issues, https://github.com/haddocking/protein-quest/issues
+Project-URL: Documentation, https://www.bonvinlab.org/protein-quest/
+Project-URL: Source, https://github.com/haddocking/protein-quest
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: aiofiles>=24.1.0
+Requires-Dist: aiohttp-retry>=2.9.1
+Requires-Dist: aiohttp[speedups]>=3.11.18
+Requires-Dist: aiopath>=0.7.7
+Requires-Dist: attrs>=25.3.0
+Requires-Dist: bokeh>=3.7.3
+Requires-Dist: cattrs[orjson]>=24.1.3
+Requires-Dist: dask>=2025.5.1
+Requires-Dist: distributed>=2025.5.1
+Requires-Dist: gemmi>=0.7.3
+Requires-Dist: molviewspec>=1.6.0
+Requires-Dist: pandas>=2.3.0
+Requires-Dist: platformdirs>=4.3.8
+Requires-Dist: psutil>=7.0.0
+Requires-Dist: rich-argparse>=1.7.1
+Requires-Dist: rich>=14.0.0
+Requires-Dist: sparqlwrapper>=2.0.0
+Requires-Dist: tqdm>=4.67.1
+Provides-Extra: mcp
+Requires-Dist: fastmcp>=2.11.3; extra == 'mcp'
+Requires-Dist: pydantic>=2.11.7; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# protein-quest
+
+[![Documentation](https://img.shields.io/badge/Documentation-bonvinlab.org-blue?style=flat-square&logo=gitbook)](https://www.bonvinlab.org/protein-quest/)
+[![CI](https://github.com/haddocking/protein-quest/actions/workflows/ci.yml/badge.svg)](https://github.com/haddocking/protein-quest/actions/workflows/ci.yml)
+[![Research Software Directory Badge](https://img.shields.io/badge/rsd-00a3e3.svg)](https://www.research-software.nl/software/protein-quest)
+[![PyPI](https://img.shields.io/pypi/v/protein-quest)](https://pypi.org/project/protein-quest/)
+<!-- TODO replace with correct zenodo id -->
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15632658.svg)](https://doi.org/10.5281/zenodo.15632658)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/7a3f3f1fe64640d583a5e50fe7ba828e)](https://app.codacy.com/gh/haddocking/protein-quest/coverage?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+
+Python package to search/retrieve/filter proteins and protein structures.
+
+It uses
+
+- [Uniprot Sparql endpoint](https://sparql.uniprot.org/) to search for proteins and their measured or predicted 3D structures.
+- [Uniprot taxonomy](https://www.uniprot.org/taxonomy?query=*) to search for taxonomy.
+- [QuickGO](https://www.ebi.ac.uk/QuickGO/api/index.html) to search for Gene Ontology terms.
+- [gemmi](https://project-gemmi.github.io/) to work with macromolecular models.
+- [dask-distributed](https://docs.dask.org/en/latest/) to compute in parallel.
+
+An example workflow:
+
+```mermaid
+graph TB;
+    taxonomy[/Search taxon/] -. taxon_ids .-> searchuniprot[/Search UniprotKB/]
+    goterm[/Search GO term/] -. go_ids .-> searchuniprot[/Search UniprotKB/]
+    searchuniprot --> |uniprot_accessions|searchpdbe[/Search PDBe/]
+    searchuniprot --> |uniprot_accessions|searchaf[/Search Alphafold/]
+    searchuniprot -. uniprot_accessions .-> searchemdb[/Search EMDB/]
+    searchpdbe -->|pdb_ids|fetchpdbe[Retrieve PDBe]
+    searchaf --> |uniprot_accessions|fetchad(Retrieve AlphaFold)
+    searchemdb -. emdb_ids .->fetchemdb[Retrieve EMDB]
+    fetchpdbe -->|mmcif_files_with_uniprot_acc| chainfilter{Filter on chain of uniprot}
+    chainfilter --> |mmcif_files| residuefilter{Filter on chain length}
+    fetchad -->|pdb_files| confidencefilter{Filter out low confidence}
+    classDef dashedBorder stroke-dasharray: 5 5;
+    goterm:::dashedBorder
+    taxonomy:::dashedBorder
+    searchemdb:::dashedBorder
+    fetchemdb:::dashedBorder
+```
+
+(Dotted nodes and edges are side-quests.)
+
+## Install
+
+```shell
+pip install protein-quest
+```
+
+Or to use the latest development version:
+```
+pip install git+https://github.com/haddocking/protein-quest.git
+```
+
+## Usage
+
+The main entry point is the `protein-quest` command line tool which has multiple subcommands to perform actions.
+
+To use programmaticly, see [API documentation](https://www.bonvinlab.org/protein-quest/autoapi/summary/).
+
+### Search Uniprot accessions
+
+```shell
+protein-quest search uniprot \
+    --taxon-id 9606 \
+    --reviewed \
+    --subcellular-location-uniprot nucleus \
+    --subcellular-location-go GO:0005634 \
+    --molecular-function-go GO:0003677 \
+    --limit 100 \
+    uniprot_accs.txt
+```
+([GO:0005634](https://www.ebi.ac.uk/QuickGO/term/GO:0005634) is "Nucleus" and [GO:0003677](https://www.ebi.ac.uk/QuickGO/term/GO:0003677) is  "DNA binding")
+
+### Search for PDBe structures of uniprot accessions
+
+```shell
+protein-quest search pdbe uniprot_accs.txt pdbe.csv
+```
+
+`pdbe.csv` file is written containing the the PDB id and chain of each uniprot accession.
+
+### Search for Alphafold structures of uniprot accessions
+
+```shell
+protein-quest search alphafold uniprot_accs.txt alphafold.csv
+```
+
+### Search for EMDB structures of uniprot accessions
+
+```shell
+protein-quest search emdb uniprot_accs.txt emdbs.csv
+```
+
+### To retrieve PDB structure files
+
+```shell
+protein-quest retrieve pdbe pdbe.csv downloads-pdbe/
+```
+
+### To retrieve AlphaFold structure files
+
+```shell
+protein-quest retrieve alphafold alphafold.csv downloads-af/
+```
+
+For each entry downloads the summary.json and cif file.
+
+### To retrieve EMDB volume files
+
+```shell
+protein-quest retrieve emdb emdbs.csv downloads-emdb/
+```
+
+### To filter AlphaFold structures on confidence
+
+Filter AlphaFoldDB structures based on confidence (pLDDT).
+Keeps entries with requested number of residues which have a confidence score above the threshold.
+Also writes pdb files with only those residues.
+
+```shell
+protein-quest filter confidence \
+    --confidence-threshold 50 \
+    --min-residues 100 \
+    --max-residues 1000 \
+    ./downloads-af ./filtered
+```
+
+### To filter PDBe files on chain of uniprot accession
+
+Make PDBe files smaller by only keeping first chain of found uniprot entry and renaming to chain A.
+
+```shell
+protein-quest filter chain \
+    pdbe.csv \
+    ./downloads-pdbe ./filtered-chains
+```
+
+### To filter PDBe files on nr of residues
+
+```shell
+protein-quest filter residue  \
+    --min-residues 100 \
+    --max-residues 1000 \
+    ./filtered-chains ./filtered
+```
+
+### Search Taxonomy
+
+```shell
+protein-quest search taxonomy "Homo sapiens" -
+```
+
+### Search Gene Ontology (GO)
+
+You might not know what the identifier of a [Gene Ontology](https://geneontology.org/) term is at `protein-quest search uniprot`.
+You can use following command to search for a Gene Ontology (GO) term.
+
+```shell
+protein-quest search go --limit 5 --aspect cellular_component apoptosome -
+```
+
+##  Model Context Protocol (MCP) server
+
+Protein quest can also help LLMs like Claude Sonnet 4 by providing a [set of tools](https://modelcontextprotocol.io/docs/learn/server-concepts#tools-ai-actions) for protein structures.
+
+![Protein Quest MCP workflow](https://github.com/haddocking/protein-quest/raw/main/docs/protein-quest-mcp.png)
+
+To run mcp server you have to install the `mcp` extra with:
+
+```shell
+pip install protein-quest[mcp]
+```
+
+The server can be started with:
+
+```shell
+protein-quest mcp
+```
+
+The mcp server contains an prompt template to search/retrieve/filter candidate structures.
+
+## Contributing
+
+For development information and contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).

protein_quest-0.3.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+protein_quest/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+protein_quest/__version__.py,sha256=VrXpHDu3erkzwl_WXrqINBm9xWkcyUy53IQOj042dOs,22
+protein_quest/cli.py,sha256=oyDin6Z92Q17mUmTCasKgju3YUJbPu298gniNakQUwY,31121
+protein_quest/emdb.py,sha256=QEeU0VJQ4lLM-o5yAU3QZlrtzDZNgnC5fCjlqPtTyAY,1370
+protein_quest/filters.py,sha256=GNtM1N1S1mNUqAvX7OvyhOvnUWo4qx2hMneORbc-Qz8,3797
+protein_quest/go.py,sha256=ycV3-grxuIKFt28bFgH6iRKmt5AEGi7txoTbaAnBxQE,5684
+protein_quest/mcp_server.py,sha256=xIaOy6sY_gW5R_oMImI2yBmbBGtZZICOxXLzOkFmm-w,7197
+protein_quest/parallel.py,sha256=kCH6KCJYJZVoq0_Qz8ZLbHnf2OJG-h4uxd9oH2rLNKc,2201
+protein_quest/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+protein_quest/taxonomy.py,sha256=kAKKZT_mOtmX8ZWNIE9i7emE23VEewkj12X7d_t3p2Y,4659
+protein_quest/uniprot.py,sha256=8qWV4GWqHTRfed0bE_TdgsLYcnDT_vzKu-6JxIgapJQ,18680
+protein_quest/utils.py,sha256=HUvqfsuMBIFOVFlb_QC2to_UQkiZ0_fwHLlckifuXss,3700
+protein_quest/alphafold/__init__.py,sha256=Ktasi5BRp71wO7-PpOGDpIRRtBEefs8knIdlKQeLQpk,51
+protein_quest/alphafold/confidence.py,sha256=-lbwijzVMhRd98bxwFDbSi7idiUKJ5BpOsGFrvuTEnQ,5596
+protein_quest/alphafold/entry_summary.py,sha256=P-S8qrXkU-wwIccA1nGol1lfDkUW0Sg0th_3EU-WjN8,1187
+protein_quest/alphafold/fetch.py,sha256=eq__PfqisuUIQBUM8KVghpiEOBGF-zXWNC6Ll_Hlz2E,11828
+protein_quest/pdbe/__init__.py,sha256=eNNHtN60NAGea7gvRkIzkoTXsYPK99s-ldIcKWYO6So,61
+protein_quest/pdbe/fetch.py,sha256=iTyS4ucV2KZl4jTgrUFOZhsXs3cRUIuvmTbXNm_pY8U,1850
+protein_quest/pdbe/io.py,sha256=0ldsrIHKaaurrM2FfWXbqm1iRj3q6xw8-lptfYU1yEw,6231
+protein_quest-0.3.0.dist-info/METADATA,sha256=yiHZn4gDdwilbCoxrF0pCjVk04v_O5pwpwrtr6oPLrE,7369
+protein_quest-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+protein_quest-0.3.0.dist-info/entry_points.txt,sha256=f1RtOxv9TFBO3w01EMEuFXBTMsqKsQcKlkxmj9zE-0g,57
+protein_quest-0.3.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+protein_quest-0.3.0.dist-info/RECORD,,

protein_quest-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

protein_quest-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+protein-quest = protein_quest.cli:main

protein_quest-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.