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.8.2.tar.gz (16.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.8.2-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.8.2.tar.gz
  • Upload date:
  • Size: 16.2 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.8.2.tar.gz
Algorithm Hash digest
SHA256 cee8a7efeddabbe9da85f04ec322d171cafc67b53d8110f5d37950ee9e5f28bc
MD5 f26fc67a680cb8f242c55759ac466cbe
BLAKE2b-256 d8f41c8eced8edf5bc70a5525ce36919a9eff6e65ba6b237f3304644b65d0ab9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8feed3cf6a07398333975c66faf261be956978722bbd7e5a36a7c26def5aa04c
MD5 2e6d07fb45261566a6608b1332c2a377
BLAKE2b-256 1f466369e71846bd976d21ae55ebb992acf1b05cdbfb64c62ea82c61f94a7c0d

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