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.0.tar.gz (23.3 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.0-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-2.0.0.tar.gz
  • Upload date:
  • Size: 23.3 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.0.tar.gz
Algorithm Hash digest
SHA256 c0920c0d803bf45cbbb999aaee4e248ee444f087c8780de028cb077563ac2c51
MD5 18ed0b21578a2d74281284226332e07e
BLAKE2b-256 a83b4a70633e0f5ad4fce2b1bc9a4d039b5fdf192b48649f487bb824c74ead85

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 19bda4e0f025dbc1bf3e924390fc29fd80a634451df2467d2707f5ab03b7188c
MD5 58f75f780c512f17ea347a20478a610f
BLAKE2b-256 2bba6e7e1fc9e8b3e2c6d04f344bd3035dc232f56a6b5d3058504b1bbcb1caad

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