Skip to main content

Tools for a easy connection with the MLC authentication portal

Project description

Usage

Install

pip install mlc_auth

Initialize

Before initializing MLC_Auth, the app.config['SECRET_KEY'] must be set.

from mlc_auth import MLC_Auth

mlc_auth = MLC_Auth(app=app)

Use on routes

The accessable_by parameter is optional. When accessable_by is None, all logged in users have access.

@app.route('/edit', methods=['GET'])
@mlc_auth.auth_required(accessable_by=['guest', 'user', 'manager', 'administrator'])
def edit_page():
    return render_template('edit.html')

Current user model

User model properties:

  • id
  • email
  • name
  • role
  • organisation_id
  • organisation_name

usage:

from flask_login import current_user

print(current_user.id) 

Fetch data from the API

from mlc_auth import MLC_Auth

organisation_info = MLC_Auth.api.get(endpoint='/api/organisation/1', params={'key':'value'})

response = MLC_Auth.api.put(endpoint='/api/user/1/settings', body={'key': 'value'}, params={'key':'value'})

Development environment

  1. The following line needs to be added to your Hosts file:
127.0.0.1 local-<Your app name here>.mlc-services.com
  1. Start the application development server.
  2. Go to http://local-<Your app name here>.mlc-services.com:5000

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

mlc_auth-1.5.2.tar.gz (4.0 kB view details)

Uploaded Source

File details

Details for the file mlc_auth-1.5.2.tar.gz.

File metadata

  • Download URL: mlc_auth-1.5.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.2

File hashes

Hashes for mlc_auth-1.5.2.tar.gz
Algorithm Hash digest
SHA256 1936bfe022a5727401dc572db41f9725d51a3c1256db684756ec3adf156f5a8e
MD5 f846d8f3c75a98b166b228f7182ad082
BLAKE2b-256 babdb8cf61f927ed54b79e6891dfbc08a4bf6b89f16dd6e82633d20c3b11c5b3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page