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.4.tar.gz (24.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-2.0.4-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-2.0.4.tar.gz
  • Upload date:
  • Size: 24.2 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.4.tar.gz
Algorithm Hash digest
SHA256 898daf502dc5d1360b2d70477effc8a5c28cdaecfe4215e123af8745fa6c100f
MD5 fa63e8e7459a3e009e2dc2e9a0254743
BLAKE2b-256 ea98a731817a8a26b12a2a5c4ca1b9d603b070e62919f5dd8f6acc39e48a09b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2518c53e3742f9c3c7d6ed435ba4c5dd47f75f74148ec7f00f1ef06fbde33604
MD5 2a5eef1c91d3a07121eb569b3d81ae2d
BLAKE2b-256 10b0a9e2da9af0e245bcb5aaf8e95ef2d03675be0c536894a436639b1fee9e28

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