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.7.1.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.7.1-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.7.1.tar.gz
  • Upload date:
  • Size: 13.5 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.7.1.tar.gz
Algorithm Hash digest
SHA256 c2be7260389ada3e857a3a86801a8b7195df87be0bfef16933fa3a6102cec64b
MD5 46dce2ccfaf252fcb3883f20a2b8a89e
BLAKE2b-256 3f83a4ff689e4949f3e6323d53708f5122d562991e04f6ba1914edb084e5a775

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a468f449015be6ac28ec633ba4b0bf71205bec5f1b7c673c27d363099ebf085c
MD5 cf3997bb62c14689d386055892d64b79
BLAKE2b-256 4f61da63041c1e9e5396f1f3cac7d7b652e62bfdf726d66372d7f32298ca1291

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