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.0.tar.gz (16.4 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.0-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.9.0.tar.gz
  • Upload date:
  • Size: 16.4 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.0.tar.gz
Algorithm Hash digest
SHA256 e63945b66edef59f5dcc85f7c1235c04080da6c977a8600a6f4860441a1d4961
MD5 bc34947a75d324ddf74584323d27c418
BLAKE2b-256 c176bdfc41843d2ff78f86ab00d6aaa38be9045259fc0229b551bab9f2cafc89

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3002a383010546eed3661e2e22ad2360b335e420991fc702dafe35f8680a00d7
MD5 59fe9a0037f196fe18e9f0332fba4a5b
BLAKE2b-256 2f3d30d35a567f98eead2e11d63bbcac9e7d95966863b1b7bfe1b9f7c1859a8e

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