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.8.tar.gz (18.9 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.8-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.9.8.tar.gz
  • Upload date:
  • Size: 18.9 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.8.tar.gz
Algorithm Hash digest
SHA256 497185f491719a5f26088d633942e1fb585090aae42f7dd2e56b9fb8a0ab4e0b
MD5 978c68e711a8711c3ee7c208611676be
BLAKE2b-256 fa055557f94af765cea7a1065c24a155948800a71f6988b185d2b62fff6abc2f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.9.8-py3-none-any.whl
Algorithm Hash digest
SHA256 93fbb33e08ede39c27c51a58a823017a2361fac6b22fb9bef6a7bb2e5d04dfde
MD5 4778a9e60240ded9ea835f5c3f81ef8e
BLAKE2b-256 0136c1bfb0a3b63b07b5be65899a46b5ae64c5bdd3e0110bbd0fb3a592acc374

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