| Name | pyAtoM JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | None |
| Summary | Python library for the AtoM archival description and access platform API |
| upload_time | 2025-02-06 17:05:01 |
| maintainer | None |
| docs_url | None |
| author | James Carr |
| requires_python | None |
| license | Apache License 2.0 |
| keywords |
api
preservation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyAtoM
Python Library for the AtoM Archival Description Platform API
This library provides a Python class for working with the AtoM Archival Description Rest API
https://accesstomemory.org/en/docs/2.8/dev-manual/api/api-intro/
The Library provides APIs for the following:
* Get a record by its Slug
* Get a record by its identifier
* Search for records
* Download a digital object attached to a record
* List taxonomy terms
## License
The package is available as open source under the terms of the Apache License 2.0
## Installation
pyAtoM is available from the Python Package Index (PyPI)
https://pypi.org/project/pyAtoM/
To install pyAtoM, simply run this simple command in your terminal of choice:
$ pip install pyAtoM
## Examples
Finding records by Slug
from pyAtoM import *
client = AccessToMemory(username="demo@example.com", password="demo", server="demo.accesstomemory.org")
slug: str = "my-slug"
item: dict = client.get(slug)
Searching for all Records
from pyAtoM import *
client = AccessToMemory(username="demo@example.com", password="demo", server="demo.accesstomemory.org")
for result in client.search():
print(result)
Searching for Records with Query terms
from pyAtoM import *
client = AccessToMemory(username="demo@example.com", password="demo", server="demo.accesstomemory.org")
queries: list = []
queries.append(Query(query_value="horses", query_field=QueryField.title))
queries.append(Query(query_value='Sudbury', query_operator=QueryOperator.or_terms, query_field=QueryField.all))
for result in client.search(query_terms=queries):
print(result)
Raw data
{
"_id": null,
"home_page": null,
"name": "pyAtoM",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "API Preservation",
"author": "James Carr",
"author_email": "drjamescarr@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/26/99/05e739aea93edbb39831a7217adf92b7a244980c89f3f461df86ee5c82b1/pyatom-0.3.0.tar.gz",
"platform": null,
"description": "# pyAtoM\r\n\r\nPython Library for the AtoM Archival Description Platform API\r\n\r\nThis library provides a Python class for working with the AtoM Archival Description Rest API\r\n\r\nhttps://accesstomemory.org/en/docs/2.8/dev-manual/api/api-intro/\r\n\r\nThe Library provides APIs for the following:\r\n\r\n* Get a record by its Slug\r\n* Get a record by its identifier\r\n* Search for records\r\n* Download a digital object attached to a record\r\n* List taxonomy terms \r\n\r\n\r\n\r\n## License\r\n\r\nThe package is available as open source under the terms of the Apache License 2.0\r\n\r\n\r\n## Installation\r\n\r\npyAtoM is available from the Python Package Index (PyPI)\r\n\r\nhttps://pypi.org/project/pyAtoM/\r\n\r\nTo install pyAtoM, simply run this simple command in your terminal of choice:\r\n\r\n\r\n $ pip install pyAtoM\r\n\r\n\r\n## Examples\r\n\r\nFinding records by Slug\r\n\r\n from pyAtoM import *\r\n\r\n client = AccessToMemory(username=\"demo@example.com\", password=\"demo\", server=\"demo.accesstomemory.org\")\r\n\r\n slug: str = \"my-slug\"\r\n\r\n item: dict = client.get(slug)\r\n\r\n\r\nSearching for all Records\r\n\r\n from pyAtoM import *\r\n\r\n client = AccessToMemory(username=\"demo@example.com\", password=\"demo\", server=\"demo.accesstomemory.org\")\r\n\r\n for result in client.search():\r\n print(result)\r\n\r\n\r\nSearching for Records with Query terms\r\n\r\n\r\n from pyAtoM import *\r\n\r\n client = AccessToMemory(username=\"demo@example.com\", password=\"demo\", server=\"demo.accesstomemory.org\")\r\n\r\n queries: list = []\r\n\r\n queries.append(Query(query_value=\"horses\", query_field=QueryField.title))\r\n queries.append(Query(query_value='Sudbury', query_operator=QueryOperator.or_terms, query_field=QueryField.all))\r\n\r\n for result in client.search(query_terms=queries):\r\n print(result)\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Python library for the AtoM archival description and access platform API",
"version": "0.3.0",
"project_urls": {
"Discussion Forum": "https://github.com/carj/pyAtoM/discussions",
"Documentation": "https://github.com/carj/pyAtoM",
"Source": "https://github.com/carj/pyAtoM"
},
"split_keywords": [
"api",
"preservation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "213f9a2c7882bce8157faed94e5baaeaaf6980d1861502d2c6cd0a5097e846f2",
"md5": "4057705d7ce95f7d13f9b2d7b41bfa26",
"sha256": "76838d7b035cd3b2f3032d54d005b23823bcff22f0451e5b3fc06121565bcb40"
},
"downloads": -1,
"filename": "pyAtoM-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4057705d7ce95f7d13f9b2d7b41bfa26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8987,
"upload_time": "2025-02-06T17:04:59",
"upload_time_iso_8601": "2025-02-06T17:04:59.364671Z",
"url": "https://files.pythonhosted.org/packages/21/3f/9a2c7882bce8157faed94e5baaeaaf6980d1861502d2c6cd0a5097e846f2/pyAtoM-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "269905e739aea93edbb39831a7217adf92b7a244980c89f3f461df86ee5c82b1",
"md5": "f8c8de9f121bb497efdc7f21f00140a0",
"sha256": "360e9584392e91221ad07e2d4a07105c01f99f87e37901dbb962c8e91145a2f4"
},
"downloads": -1,
"filename": "pyatom-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "f8c8de9f121bb497efdc7f21f00140a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9586,
"upload_time": "2025-02-06T17:05:01",
"upload_time_iso_8601": "2025-02-06T17:05:01.208718Z",
"url": "https://files.pythonhosted.org/packages/26/99/05e739aea93edbb39831a7217adf92b7a244980c89f3f461df86ee5c82b1/pyatom-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-06 17:05:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carj",
"github_project": "pyAtoM",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyatom"
}
