# EMDB Python Client
A Python client for accessing and interacting with the [Electron Microscopy Data Bank (EMDB)](https://www.ebi.ac.uk/emdb/).
This package provides an easy-to-use interface to query EMDB entries, access metadata, and download associated files.
## 🚀 Features
- Retrieve EMDB entries by ID
- Query metadata such as resolution, sample description, and related PDBs
- Download associated files (maps, images, metadata)
- Utility models for plotting and file handling
- Access to validation analysis and annotation data
## 📚 Documentation
Full API documentation is available at:
👉 [https://emdb.readthedocs.io/en/latest/](https://emdb.readthedocs.io/en/latest/)
## 🔧 Installation
You can install the EMDB client via pip:
```bash
pip install emdb
```
## ✨ Quick Start
```python
from emdb.client import EMDB
from emdb.exceptions import EMDBNotFoundError
client = EMDB()
try:
# Retrieve an entry by ID
entry = client.get_entry("EMD-8117")
print(entry.resolution)
# Access cross-reference annotations
annotations = entry.get_annotations()
for annotation in annotations:
print(annotation)
# Access validation data and plot FSC
validation = entry.get_validation()
validation.plots.fsc.plot()
# Download all files
entry.download_all_files(output_dir="/tmp/emd1234/")
# Perform a query to return EMDB entries
results = client.search("HIV")
for entry in results:
print(entry.id, entry.method, entry.resolution)
# Perform a query to return a DataFrame
table = client.csv_search("HIV")
print(table)
except EMDBNotFoundError:
print("Entry not found.")
```
## 🛠 Requirements
- Python 3.8+
See [requirements.txt](requirements.txt) for full dependencies.
## 🤝 Contributing
Contributions are welcome!
Feel free to open issues or submit pull requests.
## 📄 License
This project is licensed under the Apache License 2.0.
## 📧 Contact
For questions or feedback, please open an issue on GitHub or contact the maintainers.
Raw data
{
"_id": null,
"home_page": null,
"name": "emdb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "EMDB, Electron Microscopy, Bioinformatics, Client",
"author": null,
"author_email": "Neli Fonseca <neli@ebi.ac.uk>",
"download_url": "https://files.pythonhosted.org/packages/95/56/58d0e21968cf9a4d132b837313eec931a082dc69b0a932370c061063f8c6/emdb-0.1.9.tar.gz",
"platform": null,
"description": "# EMDB Python Client\n\nA Python client for accessing and interacting with the [Electron Microscopy Data Bank (EMDB)](https://www.ebi.ac.uk/emdb/). \nThis package provides an easy-to-use interface to query EMDB entries, access metadata, and download associated files.\n\n## \ud83d\ude80 Features\n- Retrieve EMDB entries by ID\n- Query metadata such as resolution, sample description, and related PDBs\n- Download associated files (maps, images, metadata)\n- Utility models for plotting and file handling\n- Access to validation analysis and annotation data\n\n## \ud83d\udcda Documentation\nFull API documentation is available at: \n\ud83d\udc49 [https://emdb.readthedocs.io/en/latest/](https://emdb.readthedocs.io/en/latest/)\n\n## \ud83d\udd27 Installation\nYou can install the EMDB client via pip:\n\n```bash\npip install emdb\n```\n\n## \u2728 Quick Start\n```python\nfrom emdb.client import EMDB\nfrom emdb.exceptions import EMDBNotFoundError\n\nclient = EMDB()\n\ntry:\n # Retrieve an entry by ID\n entry = client.get_entry(\"EMD-8117\")\n print(entry.resolution)\n \n # Access cross-reference annotations\n annotations = entry.get_annotations()\n for annotation in annotations:\n print(annotation)\n \n # Access validation data and plot FSC\n validation = entry.get_validation()\n validation.plots.fsc.plot()\n \n # Download all files\n entry.download_all_files(output_dir=\"/tmp/emd1234/\")\n \n # Perform a query to return EMDB entries\n results = client.search(\"HIV\")\n for entry in results:\n print(entry.id, entry.method, entry.resolution)\n \n # Perform a query to return a DataFrame\n table = client.csv_search(\"HIV\")\n print(table)\nexcept EMDBNotFoundError:\n print(\"Entry not found.\")\n```\n\n## \ud83d\udee0 Requirements\n- Python 3.8+\nSee [requirements.txt](requirements.txt) for full dependencies.\n\n## \ud83e\udd1d Contributing\nContributions are welcome!\nFeel free to open issues or submit pull requests.\n\n## \ud83d\udcc4 License\nThis project is licensed under the Apache License 2.0.\n\n## \ud83d\udce7 Contact\nFor questions or feedback, please open an issue on GitHub or contact the maintainers.\n\n",
"bugtrack_url": null,
"license": "Apache 2",
"summary": "A Python client for accessing the Electron Microscopy Data Bank (EMDB)",
"version": "0.1.9",
"project_urls": {
"Bug Tracker": "https://github.com/emdb-empiar/emdb-api-wrapper/issues",
"Documentation": "https://emdb.readthedocs.io/en/latest/",
"Homepage": "https://www.ebi.ac.uk/emdb/",
"Repository": "https://github.com/emdb-empiar/emdb-api-wrapper"
},
"split_keywords": [
"emdb",
" electron microscopy",
" bioinformatics",
" client"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b68f05e507af3d1b42b07cc2e0eeb76ee9b1adf058b7b11f99646fa698842cb3",
"md5": "78832beabae1b95e4e051b00b58a8fbc",
"sha256": "315d6518c774de0e85330fee454aef8bc157a2f9136a1d9648a3e41021ad12cf"
},
"downloads": -1,
"filename": "emdb-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78832beabae1b95e4e051b00b58a8fbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 22006,
"upload_time": "2025-08-13T10:26:57",
"upload_time_iso_8601": "2025-08-13T10:26:57.744573Z",
"url": "https://files.pythonhosted.org/packages/b6/8f/05e507af3d1b42b07cc2e0eeb76ee9b1adf058b7b11f99646fa698842cb3/emdb-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "955658d0e21968cf9a4d132b837313eec931a082dc69b0a932370c061063f8c6",
"md5": "151bebd3e9defb0667447af10e5de16d",
"sha256": "64ee5314f5e64f2a9bc1485576c6a426815726b8c6fd47fe53a9199101bf341f"
},
"downloads": -1,
"filename": "emdb-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "151bebd3e9defb0667447af10e5de16d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19848,
"upload_time": "2025-08-13T10:26:59",
"upload_time_iso_8601": "2025-08-13T10:26:59.008422Z",
"url": "https://files.pythonhosted.org/packages/95/56/58d0e21968cf9a4d132b837313eec931a082dc69b0a932370c061063f8c6/emdb-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 10:26:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emdb-empiar",
"github_project": "emdb-api-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "matplotlib",
"specs": [
[
"==",
"3.10.3"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.3.1"
]
]
},
{
"name": "pydantic",
"specs": [
[
"==",
"2.11.7"
]
]
},
{
"name": "sphinx",
"specs": [
[
"==",
"8.2.3"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"==",
"3.0.2"
]
]
}
],
"lcname": "emdb"
}
JSON
