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.6.0.tar.gz (13.3 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.6.0-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.6.0.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for freud_api_crawler-1.6.0.tar.gz
Algorithm Hash digest
SHA256 11b5dfe9a4031059b81a212252c2f5a4010833436b5294adb8bc95c6af22d55b
MD5 a308066f9fca8f664fbae84d7cac4d64
BLAKE2b-256 723e0135f20df4bace6cab92a8112209cddb3c995f0b3a7de6ff3a8939e8fc9d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2ef79fd3c289615f47c3873933ddd3835f8b9c0506d2484c65ae4735be240425
MD5 28967c2732603823c3515e5cc5f21cd9
BLAKE2b-256 d19ba7b6e94db59cea58579a375bd48daeed0a9c5978eb3f77f531114475ad7b

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