{ "info": { "author": "Osma Suominen", "author_email": "osma.suominen@helsinki.fi", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Finna-client\n\nThis is a minimal Python 3.x client library for accessing the [Finna.fi REST\nAPI](https://api.finna.fi). The API can be used to search for records (e.g.\nbooks and images) in the Finna discovery service and to retrieve information\nabout individual records.\n\n## Installation\n\nThe easiest way to install is via pip:\n\n pip3 install finna-client\n\n## Dependencies\n\nThe library depends on the\n[requests](http://docs.python-requests.org/en/master/#) module which is used\nfor HTTP/REST access. If you install this via pip, the dependencies will be\nhandled automatically.\n\n## How to use\n\nThe client library comes with examples demonstrating its usage. You can invoke\nthe example simply by running the [finna_client.py](finna_client.py) script.\n\nIn your own code, you can use the FinnaClient class like this:\n\n from finna_client import FinnaClient\n\n # then you can create your own client\n finna = FinnaClient()\n\n## Example invocation\n\nHere is the output from a typical example session:\n\n $ python3 finna_client.py\n Demonstrating usage of FinnaClient\n\n * Creating a FinnaClient object\n Now we have a FinnaClient object: FinnaClient(api_base='https://api.finna.fi/api/v1/')\n\n * Performing a general search\n Search would have matched 1354 records\n {'buildings': [{'value': '0/Helmet/', 'translated': 'Helmet-kirjastot'}, {'value': '1/Helmet/v/', 'translated': 'Vantaa'}, {'value': '2/Helmet/v/v28/', 'translated': 'L\u00e4nsim\u00e4ki'}], 'onlineUrls': [], 'series': [], 'subjects': [['matkailu'], ['py\u00f6r\u00e4ily'], ['polkupy\u00f6r\u00e4t'], ['kulkuneuvot']], 'languages': ['eng'], 'rating': {'count': 0, 'average': 0}, 'images': ['/Cover/Show?author=Byrne%2C+David&callnumber=&size=large&title=Bicycle+diaries&recordid=helmet.2029887&source=Solr&isbn=0571241034&index=0'], 'formats': [{'value': '0/Book/', 'translated': 'Kirja'}, {'value': '1/Book/Book/', 'translated': 'Kirja'}], 'presenters': {'presenters': [], 'details': []}, 'id': 'helmet.2029887', 'title': 'Bicycle diaries', 'nonPresenterAuthors': [{'name': 'Byrne, David'}]}\n {'buildings': [{'value': '0/Heili/', 'translated': 'Heili-kirjastot'}, {'value': '1/Heili/12/', 'translated': 'Parikkala'}, {'value': '2/Heili/12/321/', 'translated': 'Saaren kirjasto'}], 'onlineUrls': [], 'series': [{'name': 'The Boxcar Children'}], 'subjects': [], 'languages': ['eng'], 'rating': {'count': 0, 'average': 0}, 'images': [], 'formats': [{'value': '0/Book/', 'translated': 'Kirja'}, {'value': '1/Book/Book/', 'translated': 'Kirja'}], 'presenters': {'presenters': [], 'details': []}, 'id': 'heili.888120', 'title': 'Bicycle Mystery', 'nonPresenterAuthors': [{'name': 'Warner, Gertrude Chandler'}, {'name': 'Cunningham, David kuvittanut', 'role': 'aut'}]}\n {'buildings': [{'value': '0/Keski/', 'translated': 'Keski-kirjastot'}, {'value': '1/Keski/jyv/', 'translated': 'Jyv\u00e4skyl\u00e4'}], 'onlineUrls': [], 'series': [], 'subjects': [['free jazz', 'triot', '2000-2009'], ['jazz', 's\u00e4hk\u00f6kitara', 'Suomi', '2000-2009'], ['jazz', 'bassokitara', 'Yhdysvallat', '2000-2009'], ['jazz', 'kontrabasso', 'Yhdysvallat', '2000-2009'], ['jazz', 'rummut', 'Saksa', '2000-2009'], ['psykedeelinen rock', '2000-2009']], 'languages': ['eng'], 'rating': {'count': 0, 'average': 0}, 'images': [], 'formats': [{'value': '0/Sound/', 'translated': '\u00c4\u00e4nite'}, {'value': '1/Sound/CD/', 'translated': 'CD'}], 'presenters': {'presenters': [{'name': 'Johnny La Marama', 'role': 'esitt.'}, {'name': 'Kalima, Kalle', 'role': 'esitt.'}], 'details': ['Johnny La Marama: Chris Dahlgren (b, electronics, voc), Kalle Kalima (g, electronics, voc), Eric Schaefer (dr, perc, sampler, voc)']}, 'id': 'keski.512598', 'title': 'Bicycle revolution', 'nonPresenterAuthors': []}\n {'buildings': [{'value': '0/Helmet/', 'translated': 'Helmet-kirjastot'}, {'value': '1/Helmet/k/', 'translated': 'Kauniainen'}, {'value': '2/Helmet/k/k01/', 'translated': 'Kauniainen'}], 'onlineUrls': [], 'series': [], 'subjects': [['1940-luku'], ['1950-luku'], ['Yhdysvallat']], 'languages': ['eng'], 'rating': {'count': 0, 'average': 0}, 'images': [], 'formats': [{'value': '0/Sound/', 'translated': '\u00c4\u00e4nite'}, {'value': '1/Sound/SoundDisc/', 'translated': '\u00c4\u00e4nilevy'}], 'presenters': {'presenters': [{'name': 'Gaddy, Bob', 'role': 'esitt\u00e4j\u00e4'}, {'name': 'Gaddy, Bob', 'role': 'laulaja'}, {'name': 'Gaddy, Bob', 'role': 'piano'}, {'name': 'Dupree, Jac', 'role': 'laulaja'}, {'name': 'Dupree, Jack', 'role': 'piano'}, {'name': 'Sue, Bobby', 'role': 'laulaja'}], 'details': []}, 'id': 'helmet.1252370', 'title': 'Bicycle boogie', 'nonPresenterAuthors': [{'name': 'Gaddy, Bob', 'role': 's\u00e4velt\u00e4j\u00e4'}, {'name': 'McGhee, Brownie', 'role': 's\u00e4velt\u00e4j\u00e4'}, {'name': 'Dupree, Jack', 'role': 's\u00e4velt\u00e4j\u00e4'}, {'name': 'Dale, Larry', 'role': 's\u00e4velt\u00e4j\u00e4'}, {'name': 'Sue, Bobby', 'role': 's\u00e4velt\u00e4j\u00e4'}, {'name': 'Terry, Sonny', 'role': 'huuliharppu'}, {'name': 'McGhee, Brownie', 'role': 'kitara'}, {'name': 'Harris, Bob', 'role': 'b'}, {'name': 'Wood, George', 'role': 'rummut'}, {'name': 'Dale, Larry', 'role': 'kitara'}, {'name': 'Wallace, Cedric', 'role': 'b'}, {'name': 'Johnson, Earl A.', 'role': 'rummut'}, {'name': 'Moore, Gene', 'role': 'rummut'}, {'name': 'Dodds, Baby', 'role': 'rummut'}, {'name': 'Lucas, Al', 'role': 'b'}, {'name': 'Brown, Pete', 'role': 'alttosaksofoni'}, {'name': 'Spruill, Jimmy', 'role': 'kitara'}, {'name': 'Page, June', 'role': 'b'}, {'name': 'Spoots, George', 'role': 'rummut'}]}\n {'buildings': [{'value': '0/Eepos/', 'translated': 'Eepos-kirjastot'}, {'value': '1/Eepos/50/', 'translated': 'Kauhava'}, {'value': '2/Eepos/50/402/', 'translated': 'Kauhavan p\u00e4\u00e4kirjasto'}, {'value': '3/Eepos/50/402/1/', 'translated': '1'}], 'onlineUrls': [], 'series': [], 'subjects': [], 'languages': ['eng'], 'rating': {'count': 0, 'average': 0}, 'images': [], 'formats': [{'value': '0/Sound/', 'translated': '\u00c4\u00e4nite'}, {'value': '1/Sound/SoundDisc/', 'translated': '\u00c4\u00e4nilevy'}], 'presenters': {'presenters': [], 'details': ['Bob Gaddy (voc, p) ; Brownie McGhee (g) ; Jack Dupree (voc, p) ; Larry Dale (voc, g) ; Bobby Sue (voc)..']}, 'id': 'eepos.2088987', 'title': 'Bicycle boogie', 'nonPresenterAuthors': [{'name': 'Gaddy, Bob'}]}\n\n * Performing a search for images available online\n Search would have matched 3 records\n Title: Lavagem do Bonfim\n URL: https://api.finna.fi/Cover/Show?id=musketti_helina.M015%3ARd3.1%3A768&index=0&size=large\n\n Title: Mainoskortti (painokuva): englantilaisen Harry Holt Trio:n mainoskortti\n URL: https://api.finna.fi/Cover/Show?id=muistaja_kerava.M011-90287&index=0&size=large\n\n Title: Postikorttipainanteinen valokuva kahdeksasta oksalla seisovasta makawi-papukaijasta Miamin Parrot Junglessa\n URL: https://api.finna.fi/Cover/Show?id=siirtolaisuusmuseo_ah.M011-1376833&index=0&size=large\n\n\n * Performing a book search by author, sorting results by date, oldest first\n Search would have matched 5477 records\n {'id': 'fennica.431237', 'year': '1800', 'title': 'Tomtesagor'}\n {'id': 'alma.510296', 'year': '1822', 'title': 'Suomen kansan wanhoja runoja, ynn\u00e4 my\u00f6s nykyisempi\u00e4 lauluja'}\n {'id': 'piki.916440', 'year': '1822', 'title': 'Suomen kansan vanhoja runoja, ynn\u00e4 my\u00f6s nykyisempi\u00e4 lauluja. Ensimm\u00e4inen osa'}\n {'id': 'sksdoria_books.10024_147698', 'year': '1822', 'title': 'Suomen kansan wanhoja runoja ynn\u00e4 my\u00f6s nykyisempi\u00e4 lauluja : 1. osa'}\n {'id': 'helka.1214011', 'year': '1822', 'title': 'Suomen kansan wanhoja runoja ynn\u00e4 my\u00f6s nykyisempi\u00e4 lauluja'}\n * Retrieving a single record\n {'buildings': [{'value': '0/NLF/', 'translated': 'Kansalliskirjasto'}, {'value': '1/NLF/fennica/', 'translated': 'Fennica'}], 'onlineUrls': [], 'series': [], 'subjects': [], 'languages': [], 'rating': {'count': 0, 'average': 0}, 'images': [], 'formats': [{'value': '0/Book/', 'translated': 'Kirja'}, {'value': '1/Book/Book/', 'translated': 'Kirja'}], 'presenters': {'presenters': [], 'details': []}, 'id': 'fennica.431237', 'title': 'Tomtesagor', 'nonPresenterAuthors': [{'name': 'Topelius, Z., puuteluettelotieto'}]}\n\n * Retrieving multiple records\n {'id': 'alma.510296', 'title': 'Suomen kansan wanhoja runoja, ynn\u00e4 my\u00f6s nykyisempi\u00e4 lauluja'}\n {'id': 'piki.916440', 'title': 'Suomen kansan vanhoja runoja, ynn\u00e4 my\u00f6s nykyisempi\u00e4 lauluja. Ensimm\u00e4inen osa'}\n {'id': 'fennica.431237', 'title': 'Tomtesagor'}\n\n## License\n\nThe code is published under the [Apache 2.0](LICENSE.txt) license.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/NatLibFi/Finna-client", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "finna-client", "package_url": "https://pypi.org/project/finna-client/", "platform": "", "project_url": "https://pypi.org/project/finna-client/", "project_urls": { "Homepage": "https://github.com/NatLibFi/Finna-client" }, "release_url": "https://pypi.org/project/finna-client/0.1.2/", "requires_dist": [ "requests", "bumpversion; extra == 'dev'" ], "requires_python": "", "summary": "Python client library for accessing Finna REST API", "version": "0.1.2" }, "last_serial": 4410907, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "af3d4e7a932dbff7415677920a6c34bb", "sha256": "9067153cbf429dc5512f7d8e3d34f2dec46d24310339f34da7636107fda124ec" }, "downloads": -1, "filename": "finna_client-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "af3d4e7a932dbff7415677920a6c34bb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6080, "upload_time": "2018-10-24T12:33:38", "url": "https://files.pythonhosted.org/packages/d3/33/ce9351ab4d53723c0a15cf7b09f1d8cca089d0a8f9227cb4936c5ef3feca/finna_client-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2597f534656fd3c68715226d67bff8cd", "sha256": "366a9d68cf06742f460b2e7df910183af172d40552a7958017d078873305a5d6" }, "downloads": -1, "filename": "finna-client-0.1.2.tar.gz", "has_sig": false, "md5_digest": "2597f534656fd3c68715226d67bff8cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5428, "upload_time": "2018-10-24T12:33:39", "url": "https://files.pythonhosted.org/packages/8a/33/251bc5168e834b9bc6113c161c373f47a7e702cbc811995df40e11582c6c/finna-client-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "af3d4e7a932dbff7415677920a6c34bb", "sha256": "9067153cbf429dc5512f7d8e3d34f2dec46d24310339f34da7636107fda124ec" }, "downloads": -1, "filename": "finna_client-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "af3d4e7a932dbff7415677920a6c34bb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6080, "upload_time": "2018-10-24T12:33:38", "url": "https://files.pythonhosted.org/packages/d3/33/ce9351ab4d53723c0a15cf7b09f1d8cca089d0a8f9227cb4936c5ef3feca/finna_client-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2597f534656fd3c68715226d67bff8cd", "sha256": "366a9d68cf06742f460b2e7df910183af172d40552a7958017d078873305a5d6" }, "downloads": -1, "filename": "finna-client-0.1.2.tar.gz", "has_sig": false, "md5_digest": "2597f534656fd3c68715226d67bff8cd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5428, "upload_time": "2018-10-24T12:33:39", "url": "https://files.pythonhosted.org/packages/8a/33/251bc5168e834b9bc6113c161c373f47a7e702cbc811995df40e11582c6c/finna-client-0.1.2.tar.gz" } ] }