Skip to main content

Utility to download or upload data from/to .Stat Suite using ADFS authentication to connect to it

Project description

DotStat_IO:

A generic python package which could be integrated with other end-user applications and Gitlab runner to perform basic io with .Stat Suite. Its role is to mask the complexities of authentication to connect to .Stat Suite. The user needs to provide a set of parameters and the package exposes a couple of methods which will download or upload data from/to .Stat Suite.

This package contains three modules:

  • ADFSAuthentication module
  • KeycloakAuthentication module
  • Download_upload module

In ADFSAuthentication module, four methods are available:

1. To initialise the module for interactive use:

from dotstat_io.authentication import AdfsAuthentication
with AdfsAuthentication.interactive(
        client_id=client_id,
        sdmx_resource_id=sdmx_resource_id,
        scopes=scopes,
        authority_url=authority_url,
        redirect_port=redirect_port) as Interactive_obj:
    access_token = Interactive_obj.get_token()
  • client_id: The Application (client) ID that the ADFS assigned to your app
  • sdmx_resource_id: The ID of the application to be accessed such as .Stat Suite
  • scopes: Scopes requested to access a protected API (a resource defined by sdmx_resource_id)
  • authority_url: URL that identifies a token authority
  • redirect_port: The port of the address to return to upon receiving a response from the authority

2. To initialise the module for non-interactive use using a secret:

from dotstat_io.authentication import AdfsAuthentication
with AdfsAuthentication.nointeractive_with_secret(
        client_id=client_id,
        sdmx_resource_id=sdmx_resource_id,
        scopes=scopes,
        authority_url=authority_url,
        client_secret=client_secret) as Nointeractive_with_secret_obj:
    access_token = Nointeractive_with_secret_obj.get_token()
  • client_id: The Application (client) ID that the ADFS assigned to your app
  • sdmx_resource_id: The ID of the application to be accessed such as .Stat Suite
  • scopes: Scopes requested to access a protected API (a resource defined by sdmx_resource_id)
  • authority_url: URL that identifies a token authority
  • client_secret: The application secret that you created during app registration in ADFS

3. To initialise the module for non-interactive use using windows client authentication:

from dotstat_io.authentication import AdfsAuthentication
with AdfsAuthentication.nointeractive_with_adfs(
        client_id=client_id,
        sdmx_resource_id=sdmx_resource_id,
        token_url=token_url) as Nointeractive_with_adfs_obj:
    access_token = Nointeractive_with_adfs_obj.get_token()
  • client_id: The Application (client) ID that the ADFS assigned to your app
  • sdmx_resource_id: The ID of the application to be accessed such as .Stat Suite
  • token_url: URL of the authentication service

4. To get a token after initialisation of "AdfsAuthentication" object as shown above:

access_token = [Authentication Object Name].get_token()

In KeycloakAuthentication module, two methods are available:

1. To initialise the module for Keycloak authentication:

from dotstat_io.authentication import KeycloakAuthentication
with KeycloakAuthentication.nointeractive_with_secret(
        user=user,
        password=password, 
        token_url=token_url, 
        proxy=proxy) as Nointeractive_with_keycloak_obj:
    access_token = Nointeractive_with_keycloak_obj.get_token()
  • user: User name for .Stat Suite authentication
  • password: User name's password
  • token_url: URL of the authentication service
  • proxy: URL of the SSL certificates

2. To get a token after initialisation of "KeycloakAuthentication" object as shown above:

access_token = [Authentication Object Name].get_token()

In Download_upload module, four methods are available:

1. To download a file from .Stat Suite:

from dotstat_io.download_upload import Download_upload
with Download_upload(adfsAuthentication_obj, access_token) as Download_upload_obj:
    Returned_Message = Download_upload_obj.download_file(
        dotstat_url, content_format, Path(file_path))
  • dotstat_url: URL of data to be downloaded from .Stat Suite
  • content_format: Format of the downloaded content
  • file_path: The full path where the file will downloaded

2. To download streamed content from .Stat Suite:

from dotstat_io.download_upload import Download_upload
with Download_upload(adfsAuthentication_obj, access_token) as Download_upload_obj:
    Returned_Message = Download_upload_obj.download_stream(
        dotstat_url, content_format)
  • dotstat_url: URL of data to be downloaded from .Stat Suite
  • content_format: Format of the downloaded content

3. To upload a data file to .Stat Suite:

from dotstat_io.download_upload import Download_upload
with Download_upload(adfsAuthentication_obj, access_token) as Download_upload_obj:
    Returned_Message = Download_upload_obj.upload_file(
        transfer_url, Path(file_path), space, validationType, use_filepath)
  • transfer_url: URL of the transfer service
  • file_path: The full path of the SDMX-CSV file, which will be uploaded to .Stat Suite
  • space: Data space where the file will be uploaded
  • validationType: The type of validation to use during upload. Possible values: Basic Validation (0), Advanced Validation (1)
  • use_filepath: Use a file path of a shared folder accessible by the .Stat Suite data upload engine (for unlimited file sizes)

4. To upload a structure to .Stat Suite:

from dotstat_io.download_upload import Download_upload
with Download_upload(adfsAuthentication_obj, access_token) as Download_upload_obj:
    Returned_Message = Download_upload_obj.upload_structure(
        transfer_url, Path(file_path))
  • transfer_url: URL of the transfer service
  • file_path: The full path of the SDMX-ML file, which will be uploaded to .Stat Suite

For more information about how to use this package, all test cases can be accessed from this link

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

dotstat_io-0.2.7.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

dotstat_io-0.2.7-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file dotstat_io-0.2.7.tar.gz.

File metadata

  • Download URL: dotstat_io-0.2.7.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.11 Windows/10

File hashes

Hashes for dotstat_io-0.2.7.tar.gz
Algorithm Hash digest
SHA256 4ee6703c204f1ce6eda388e36d6f0288be8def8c20755146631af218220d3fd9
MD5 e3744a088e64479c144565a8a1232d67
BLAKE2b-256 447a1fbe1790db7b5fc70b8ca34fe15eb223a9b7d0b6a428fc5afb1b120fc257

See more details on using hashes here.

File details

Details for the file dotstat_io-0.2.7-py3-none-any.whl.

File metadata

  • Download URL: dotstat_io-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.11 Windows/10

File hashes

Hashes for dotstat_io-0.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 159b0cb766749b2e1364060aca08e9a7ffca85cf17f3a3dc63e2f773411d1848
MD5 500953c93902792259adda1bb019da12
BLAKE2b-256 965f564b63241b81ddf9aa4ac27330684c909397f9c2d451ff97742e1c6f9acc

See more details on using hashes here.

Supported by

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