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.5.2.tar.gz (13.2 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.5.2-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.5.2.tar.gz
  • Upload date:
  • Size: 13.2 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.5.2.tar.gz
Algorithm Hash digest
SHA256 48e6559d1fb6b3e1d49a56a461e476f17b1de8eeab4e42c70e793480b27c2cfe
MD5 1a1eb4ba8c35765a56ea27269de5bff9
BLAKE2b-256 d5f3320732887172fe4c7692f6bfb7b6e326b8a4dd197c68751b35835c5b9aec

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 47b3a38268c883d84ee8c106daed4b47c9fababfde0622c9a2dbbd36ac55ed1f
MD5 9e3f1344d82e10f65e079f920799358d
BLAKE2b-256 a6d4c646d5366cf45d4a8153cf3630d4c43e2c3a204082b9df6a163c98641ee1

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