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

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.5.0.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for freud_api_crawler-1.5.0.tar.gz
Algorithm Hash digest
SHA256 3092b62a1a50ca15e76431f558b275ebbf346940d79412772be9b6a5822a9952
MD5 23d46421728ddc6960514984bbe74041
BLAKE2b-256 2a612906cae6336ba447ecd86867361724fa3c5e59ed9fead6521446c81e8f81

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 874c9bbc302acd5447836b1c6a5d7eb841395f26efdd46756eff14452358cc35
MD5 2246df55d4b776839aa4a6a9f20fd49a
BLAKE2b-256 8a607e590814991874c18e479120662d5381ed69bd944153b1e93e9a65b0b9ea

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