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.1.tar.gz (23.4 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-2.0.1-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-2.0.1.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for freud_api_crawler-2.0.1.tar.gz
Algorithm Hash digest
SHA256 e5bcb9a9dad63aec8d63445dc65e29f4ad12c390af983cf4e7f6d5268091527c
MD5 3c929ba06df98a59203feb099e80bff6
BLAKE2b-256 c995fdd59f7352c3e756cc00a637e1cfa29095d069c63a15d0bfb8df81642186

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6eb65cf2ea72a2fabe69cfe0af612342a524825f2f903c80fe7134b7d3e21423
MD5 0ddaff7c949498b392462a45edbd4bfb
BLAKE2b-256 5ac1baccda8de97c13fe994ee94d91086052f0d5a75c42a34865316474843309

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