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

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.9.7.tar.gz
  • Upload date:
  • Size: 18.9 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.7.tar.gz
Algorithm Hash digest
SHA256 85d16d16e4f3247c03f79b8893ef07b032b9267901fb7791d5c3993e567b7c5c
MD5 b17bde23aba9e1be561581b2a90f2c25
BLAKE2b-256 13f13c25682e9dad0763e0d6813a20b5de7b7e9459a7161aa02e0e0b5fb6458a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 5ce0e6c15981564b2c4e0679c07e1d6311034380c7311ea5802c5ba7d80d3385
MD5 c20149e475089920edb55b749303077d
BLAKE2b-256 29e01cb1a7a79f2aac607763fd8628472aabb41d5c01f4fc4322d377380d4a15

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