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

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.8.0.tar.gz
  • Upload date:
  • Size: 16.1 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.8.0.tar.gz
Algorithm Hash digest
SHA256 84f7e0513e9f52c3f33fbf6c26249ae805adbe71d536a03fcf56ad0e4ae662c0
MD5 54cddcd785e54ef1808abfc39a5fd952
BLAKE2b-256 7c5784884a1698e9ebe55d8834a02c287ed9e0740d5b60c42951af78508123df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0a9af7e3b5fc3c780a45adf61ad223caddfcb94bec955b5f42604bd6e58fe2d
MD5 7b0af279e7311a7d70f60867a98b183c
BLAKE2b-256 e9f47224d3c0770d052fdf7c65a76d98633bab3e852a61b8d85a7207f204eb46

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