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.9.2.tar.gz (18.7 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.9.2-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-1.9.2.tar.gz
  • Upload date:
  • Size: 18.7 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.9.2.tar.gz
Algorithm Hash digest
SHA256 5bd92044034dfa3041b160da8fdaddeb236e89b29f29c1ca9675da2a9d1800d6
MD5 e5994554efb4c05348263a6ee866507d
BLAKE2b-256 93893b2e22dfeac826579d78974bb04ec5232d317cb4abfe04a7306bc4a9a3d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-1.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6b4f9274e001b3eb10e5b7d87dec4459fe6ba2ae3c090749e753b3144448eab
MD5 5c120097dae6232e126fdd197c274d59
BLAKE2b-256 b1f0d4657b5f1e32e3b463f5dfd958ef127aff9053d7d6bf44de0ad292be4bf1

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