oauth2-xfel-client 6.0.0

Python OAUTH 2.0 Client used for Backend Application strategy login against European XFEL Web Applications

Small Python library responsible for managing users authentication using OAUTH 2.0 Client Backend Application strategy (from non web software to web Oauth2 providers)

Repository:

• https://git.xfel.eu/gitlab/ITDM/oauth2_xfel_client

Dependencies:

• oauthlib (https://pypi.python.org/pypi/oauthlib)

• requests (https://github.com/kennethreitz/requests)

• requests-oauthlib (https://github.com/requests/requests-oauthlib)

• pytz (https://pypi.org/project/pytz/)

Installation

Python project

1. Install requirements, if never done before

1.1. For OS X distributions:

sudo port install python35
sudo port

sudo port select --set python3 python35

sudo port install py35-pip
sudo port select --set pip pip35

1.2. For Linux distributions:

sudo apt-get update
sudo apt-get install python3.5

2. Make oauth2_xfel_client library available in your python environment

Install it via pip:

# Install dependencies from local wheels files
pip install --no-index --upgrade --find-links ./external_dependencies/ .

# Install dependencies from the pypi
pip install .

Running this command 2 folders are generated under the current Python installation site-packages folder:

• oauth2_xfel_client with the sources;

• oauth2_xfel_client-6.0.0.dist-info/ with metadata

To identify your Python site-packages folder run:

python -c "from distutils.sysconfig import get_python_lib; print(get_python_lib())"

Usage

To use this project you need to import it:

from oauth2_xfel_client import Oauth2ClientBackend

1. Connection to the Oauth2Client:

   from oauth2_xfel_client import Oauth2ClientBackend as Oauth2Client
   
   # Necessary configuration variables to establish a connection
   # Go to https://in.xfel.eu/metadata/oauth/applications to make a token for
   # the metadata catalogue.
   user_id = '201ed15ff071a63e76cb0b91a1ab17b36d5f92d24b6df4497aa646e39c46a324'
   user_secret = 'a8ae80f5e96531f19bf2d2b6102f5a537196aca44a673ad36533310e07529757'
   user_email = '[e-mail]'
   
   # URLs for the metadata catalogue
   token_url = 'https://in.xfel.eu/metadata/oauth/token'
   refresh_url = 'https://in.xfel.eu/metadata/oauth/token'
   auth_url = 'https://in.xfel.eu/metadata/oauth/authorize'
   scope = ''
   
   # Generate the connection
   oauth_client_valid = Oauth2Client(client_id=user_id,
                                     client_secret=user_secret,
                                     scope=scope,
                                     token_url=token_url,
                                     refresh_url=refresh_url,
                                     auth_url=auth_url,
                                     session_token=None)

2. Interaction with the oauth2Client:

2.1 Example data_group_types:

current_token = oauth_client_valid.get_session_token()

Development & Testing

When developing, and before commit changes, please validate that:

1. All tests continue passing successfully (to validate that run pytest):

   # Go to the source code directory
   cd oauth2_xfel_client
   
   # Run all tests using nosetests
   pytest
   
   # Run all tests and get information about coverage for all files inside oauth2_xfel_client package
   pip install pytest-cov
   pytest --cov oauth2_xfel_client --cov-report term-missing

2. Code keeps respecting pycodestyle code conventions (to validate that run pycodestyle):

   pycodestyle .

3. To generate all the wheels files for the dependencies, execute:

   # Generate Wheels to itself and dependencies
   pip wheel --wheel-dir=./external_dependencies .
   pip wheel --wheel-dir=./external_dependencies --find-links=./external_dependencies .

Check that you have the desired dependency versions in setup.py.

Registering library on https://pypi.org

To register this python library, the following steps are necessary:

# Install twine
python -m pip install --upgrade twine

# Generates sdist (.tar.gz) and wheel (.whl) files in the dist/ folder
python setup.py sdist bdist_wheel

# Upload new version .egg and .whl files
twine upload dist/*

# In case a test is necessary, it is possible to test it against test.pypi.org
twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose