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.3.0.tar.gz (13.5 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.3.0-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.3.0.tar.gz
  • Upload date:
  • Size: 13.5 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.3.0.tar.gz
Algorithm Hash digest
SHA256 2ebdb5ae166938fe7f3de05efacde25a5137a4cd56fff701e95e2cdf21f4d1c9
MD5 e3daa71374d255b446ea8f723d0497ad
BLAKE2b-256 0d19b94c79a7cac32bce2cc5471423e6f4debe593c5097b4b386cf260bfa5e64

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c08750d5bb0b03e7685d6846927415b413e4e7a6aa210a6933047d53812ba40
MD5 77733b797722fb8d5410fc3b4753640b
BLAKE2b-256 3ec35fed31a7dc29d593672dc51c4b45a8a9b486848b85f82d6507f8c9a260f1

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