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-2.0.7.tar.gz (24.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-2.0.7-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for freud_api_crawler-2.0.7.tar.gz
Algorithm Hash digest
SHA256 0cdc03a2a4aa631056de9e4f01a023b05dd54bc26990840d4e15213d5906bf57
MD5 dd20215edac30a4e57eae61403c0df75
BLAKE2b-256 d71df6b4d0ca8dedfda539a001b4fc96c65946964008466612fcc5497859e748

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8930f9326f8d530b925e5e3ff29f7638255c5f1a64953c5cc19c434e3d969816
MD5 c46e9d87b7c3e8e7ff0185083778aa31
BLAKE2b-256 577e8d051b2095e3ae997d48a645668afcb3e4d4600a61a7c3f49a205161b124

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