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.5.tar.gz (18.8 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.5-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.9.5.tar.gz
  • Upload date:
  • Size: 18.8 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.5.tar.gz
Algorithm Hash digest
SHA256 0909323dcaf5b5c68832f40a2003535a90a621831cbd646554be0ad9610ef7aa
MD5 9f634a69646a7ec10d03acb25a6d8c0d
BLAKE2b-256 a7711da75795357657d09ee82456256fc9549d5556e398267c2800c6a9d1da1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.9.5-py3-none-any.whl
Algorithm Hash digest
SHA256 02ac01bcc7e14a836e825be4b6289c2d9ef8e08a4453d028e129621277d742c0
MD5 8fb0986b815c92cc0afd2dca09328c25
BLAKE2b-256 099c57182f750d7214f0226ceccec786fbf77f427456d39cfee0c08bdff6b123

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