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.6.tar.gz (24.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.6-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: freud_api_crawler-2.0.6.tar.gz
  • Upload date:
  • Size: 24.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.6.tar.gz
Algorithm Hash digest
SHA256 b070e70e96f2e80438574f6adc79fc30ed90a3a90057c5a0542adef9413f7180
MD5 542e731d17150b4010fab8703017dbb3
BLAKE2b-256 da356b0be66966d9cd7d9951ca0711b4f2df985efc04d05e2a46596d6785cff6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for freud_api_crawler-2.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 edcc9ac3688fd1abe234a7a2366f188bdfaa79593349d69f612f713017ffadb4
MD5 40ecf156e4bbb0a9dbe6cb5f1f34d637
BLAKE2b-256 89446ed7a08da7c8d969d5111410f817f543eb13f1ff78896bb0ed57e5209ebb

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