[](https://badge.fury.io/py/freud-api-crawler)
[](https://codecov.io/gh/freud-digital/freud_api_crawler)
# Freud API Crawler
A client to interact with freud-net API
## install
* create a virtual environment and install the package with `pip install freud_api_crawler`
* provide FRD_USER (freud-net username) and FRD_PW (freud-net password) as environment varibles, e.g. by
* create a file called `env.secret` to store you freud-net api credentials
* run `./set_env_variables.sh`
### example `env.secret`
```
FRD_USER=username
FRD_PW=password
```
## usage
for how to use this package have a look into `./tests/test_freud_api_crawler.py` or check out the [frd-data-repo](https://github.com/freud-digital/frd-data)
## dev
* clone the repo
* create virtual env
* install dev-depenencies `pip install -r requirements_dev.txt`
* install the package (so you have the actual dependencies as well) `pip install -e .`
* run test with `coverage run -m pytest -v`
* create test-report `coverage report` or `coverage html`
## api-utils
### get work by title
https://www.freud-edition.net/jsonapi/node/werk?filter[field_titel.value]=%C3%9Cber%20den%20Traum
https://www.freud-edition.net/jsonapi/node/werk?filter[field_titel.value]=Über den Traum
### get manifestaion by node id
this ID can be taken from edit-url, e.g. https://www.freud-edition.net/node/51190/edit
https://www.freud-edition.net/jsonapi/node/manifestation?filter[drupal_internal__nid]=51190
https://www.freud-edition.net/jsonapi/node/manifestation?filter[drupal_internal__nid]=38946
https://www.freud-edition.net/node/38946/edit
Raw data
{
"_id": null,
"home_page": "https://github.com/acdh-oeaw/freud_api_crawler",
"name": "freud-api-crawler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "freud_api_crawler",
"author": "Peter Andorfer, Daniel Stoxreiter",
"author_email": "peter.andorfer@oeaw.ac.at",
"download_url": "https://files.pythonhosted.org/packages/1c/b0/3ba7472a0776cf72ac00af5a8437d1ef88a5d403eadcd32778055e5f32b8/freud_api_crawler-2.0.8.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/freud-api-crawler)\n[](https://codecov.io/gh/freud-digital/freud_api_crawler)\n\n# Freud API Crawler\n\nA client to interact with freud-net API\n\n\n## install\n\n* create a virtual environment and install the package with `pip install freud_api_crawler` \n* provide FRD_USER (freud-net username) and FRD_PW (freud-net password) as environment varibles, e.g. by\n * create a file called `env.secret` to store you freud-net api credentials\n * run `./set_env_variables.sh` \n\n### example `env.secret`\n\n```\nFRD_USER=username\nFRD_PW=password\n```\n\n## usage\n\nfor how to use this package have a look into `./tests/test_freud_api_crawler.py` or check out the [frd-data-repo](https://github.com/freud-digital/frd-data)\n\n## dev\n\n* clone the repo\n* create virtual env\n* install dev-depenencies `pip install -r requirements_dev.txt`\n* install the package (so you have the actual dependencies as well) `pip install -e .`\n\n* run test with `coverage run -m pytest -v`\n* create test-report `coverage report` or `coverage html`\n\n## api-utils\n\n### get work by title\n\nhttps://www.freud-edition.net/jsonapi/node/werk?filter[field_titel.value]=%C3%9Cber%20den%20Traum\nhttps://www.freud-edition.net/jsonapi/node/werk?filter[field_titel.value]=\u00dcber den Traum\n\n### get manifestaion by node id\n\nthis ID can be taken from edit-url, e.g. https://www.freud-edition.net/node/51190/edit\n\nhttps://www.freud-edition.net/jsonapi/node/manifestation?filter[drupal_internal__nid]=51190\n\nhttps://www.freud-edition.net/jsonapi/node/manifestation?filter[drupal_internal__nid]=38946\nhttps://www.freud-edition.net/node/38946/edit\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "A client to interact with freud-net API",
"version": "2.0.8",
"split_keywords": [
"freud_api_crawler"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "21047cfa59479b5cd7617953a3ffba8b",
"sha256": "3b6863d013e5e431fb349825e6cc5bae688aeb823b1c7f33c0980e351c2ccfd4"
},
"downloads": -1,
"filename": "freud_api_crawler-2.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21047cfa59479b5cd7617953a3ffba8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 42977,
"upload_time": "2022-12-30T11:17:19",
"upload_time_iso_8601": "2022-12-30T11:17:19.969984Z",
"url": "https://files.pythonhosted.org/packages/65/03/578f59567538a59bcedc2cfcd197ee51d651740fac52569bb8971ba1e6a5/freud_api_crawler-2.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "39646d2238f26e399057275dd4a0366a",
"sha256": "67945ae3d6fe34af187bf332bbce9d54114489f3ef293df9fb343c1ea2b60b8d"
},
"downloads": -1,
"filename": "freud_api_crawler-2.0.8.tar.gz",
"has_sig": false,
"md5_digest": "39646d2238f26e399057275dd4a0366a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 25051,
"upload_time": "2022-12-30T11:17:21",
"upload_time_iso_8601": "2022-12-30T11:17:21.627307Z",
"url": "https://files.pythonhosted.org/packages/1c/b0/3ba7472a0776cf72ac00af5a8437d1ef88a5d403eadcd32778055e5f32b8/freud_api_crawler-2.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 11:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "acdh-oeaw",
"github_project": "freud_api_crawler",
"lcname": "freud-api-crawler"
}
JSON
