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.8.tar.gz (25.1 kB view details)

Uploaded Source

Built Distribution

freud_api_crawler-2.0.8-py3-none-any.whl (43.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-2.0.8.tar.gz
  • Upload date:
  • Size: 25.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.1

File hashes

Hashes for freud_api_crawler-2.0.8.tar.gz
Algorithm Hash digest
SHA256 67945ae3d6fe34af187bf332bbce9d54114489f3ef293df9fb343c1ea2b60b8d
MD5 39646d2238f26e399057275dd4a0366a
BLAKE2b-256 1cb03ba7472a0776cf72ac00af5a8437d1ef88a5d403eadcd32778055e5f32b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3b6863d013e5e431fb349825e6cc5bae688aeb823b1c7f33c0980e351c2ccfd4
MD5 21047cfa59479b5cd7617953a3ffba8b
BLAKE2b-256 6503578f59567538a59bcedc2cfcd197ee51d651740fac52569bb8971ba1e6a5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page