Skip to main content

A client to interact with freud-net API

Project description

PyPI version codecov

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

freud_api_crawler-1.9.9.tar.gz (23.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

freud_api_crawler-1.9.9-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file freud_api_crawler-1.9.9.tar.gz.

File metadata

  • Download URL: freud_api_crawler-1.9.9.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for freud_api_crawler-1.9.9.tar.gz
Algorithm Hash digest
SHA256 a3769378c6994e848e0c91ec202b58682f95bc8d0c8325b32dcb4d150862aa1b
MD5 d0deaffed25db844b5aaafa004e8c85c
BLAKE2b-256 34c63b67d70b7dfad38b79f36d5e5922bb65ca552da4582029716cb689b00a43

See more details on using hashes here.

File details

Details for the file freud_api_crawler-1.9.9-py3-none-any.whl.

File metadata

File hashes

Hashes for freud_api_crawler-1.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4a93eaf7f493c8508c9e17b894f2c44153b12579431a357de86d2e8ec896224b
MD5 710628f12aec3aa7d7965c0c36681fd2
BLAKE2b-256 4bf73d87ae2ea7da5f153ee6c46adb8cc70c59c9de4770eafcf44a2a1c05e811

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page