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.2.tar.gz (23.6 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.2-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for freud_api_crawler-2.0.2.tar.gz
Algorithm Hash digest
SHA256 1d2ae523db4d6ed82ef95d4b59bc04fcf3b852d2331ec08c5add3d7d897c33d6
MD5 6ca326889d3665cc0f7657d2a3d52800
BLAKE2b-256 1b59d68ded3e46b6d30daf434137f22d450d78969c6af11d8ca9e93af2ff6ac4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5ce851e68a178f26b8c5351e54a556d7b2f6a4497eb360860ec0f61002f30b36
MD5 e768fc4fe6fb96b86033eb0dde4ae773
BLAKE2b-256 caff460391e956806fec8db2c32518488814e50adfa12b3648593465b60bbf84

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