Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 3.55 KB

README.md

File metadata and controls

105 lines (70 loc) · 3.55 KB
Raw

MaintainabilityTest CoveragePyPI version

Research Data Services Common Package

This package make the most common modules in Sciebo RDS available in one place, so we do not have to maintain them in several places. In the RDS project, we use OAuth2 for authentication between numerious services, so we need a datastructure with methods, which supports this.

So this package implement 3 basic classes (User, Service, Token), which handles standard user-password authentication. If you need this classes with oauth2-support, you have to use the corresponding version (e.g. Service => Oauth2Service). (Notice: User does not have an oauth2-version, because token takes care of password or token and service takes care of everything else for oauth2.)

Usage

You can find some examples to use this package below. If you need more, please take a look into the tests or sciebo RDS (e.g. Token Storage).

from RDS import User
user1 = User("Max Mustermann")

Installation

pip install research-data-services-common

Optional dependencies

If you want to work with flask, you can use some additional features, when it is installed.

pip install "research-data-services-common[flask]"

JSONEncoder

With flask installed, you can use the JSONEncoder for flask.

from flask import Flask, jsonify
from RDS import Util

app = Flask(__name__)
app.json_encoder = Util.get_encoder(func_name="to_dict")

class Storage():
    def to_dict(self):
        return {"foo": "bar"}

@app.route("/")
def hello():
    return jsonify(Storage())

If you want to use builtin json, you do not need flask. Then you can use monkeypatch-method.

from RDS import Util
import json

class Storage():
    def to_dict(self):
        return {"foo": "bar"}

Util.monkeypatch(func_name="to_dict")

print(json.dumps(Storage())) # expects: '{"foo":"bar"}'

Notice: func_name defaults to to_json.

Monkeypatch JSONEncoder in Flask

If you want to monkeypatch json and flask, you can use the helper function monkeypatch from RDS.

from RDS import Util
Util.monkeypatch()

If it runs in a flask app context, it patches the app by itself. Otherwise you have to set the app-argument.

from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello_world():
    return 'Hello, World!'

from RDS import Util
Util.monkeypatch("getDict", app=app)

The first argument in the previous example, you can see how to set the method, which should be used for json encoding from your object. The monkeypatch-method patches JSONEncoder in your python installation and your app flask.

RO-Crate Parser

This helps you to work with ro-crate-metadata files. Take a look in the tests to see, how this can be used.

Available Modules

  • User
  • Service (Oauth2Service)
  • Token (Oauth2Token)
  • ROParser