Metadata-Version: 2.1
Name: qronos-django
Version: 0.0.1
Summary: Django package for using the QRonos Python Client
Home-page: https://github.com/QuickRelease/qronos-django.git
Author: Nick Solly
Author-email: nick.solly@quickrelease.co.uk
License: All Rights Reserved
Description: # qronos-django
        Django package for using the QRonos Python Client
        
        ## Installation
        
        This package can be installed via pip:
        
        ```
        pip install qronos-django
        ```
        
        Add to your `INSTALLED_APPS`:
        
        ```python
        INSTALLED_APPS = [
            ...
            "qronos_django",
            ...
        ]
        ```
        
        ## Required Settings
        
        ### `QRONOS_HOST`
        Default: `"dev.qronos.xyz"`
        
        The URL host of the QRonos instance.
        
        ### `QRONOS_USER`
        Default: `""`
        
        The username with which to authenticate.
        
        ### `QRONOS_PASSWORD`
        Default: `""`
        
        The password with which to authenticate.
        
        ## Optional Settings
        
        ### `QRONOS_TOKEN_CACHE_KEY`
        Default: `"QRONOS_TOKEN"`
        
        The name of the cache key for Tokens
        
        ### `QRONOS_TOKEN_CACHE_FRACTION`
        Default: `0.8`
        
        What fraction of the total lifetime of tokens to cache.  Set to 0 to disable Token caching.
        
        ### `QRONOS_LOGGING`
        Default: `True`
        
        Create QRonosImportLog items in the Database to track the triggered QRonos Imports
        
        ### `QRONOS_ID_LOGGING`
        Default: `False`
        
        Store the tracker/stage/importer ID's in the QRonosImportLog items
        
        ### `QRONOS_DATA_LOGGING`
        Default: `False`
        
        Store the data sent in the QRonosImportLog items
        
        ## Example Usage
        
        ```python
        from qronos_django import tracker_import, stage_import
        from qronos_django.tasks import update_qronos_log_status
        
        # Import Tracker (Item) Data
        # If QRONOS_LOGGING enabled then this will create a QRonosImportLog item and return it, otherwise returns None
        import_log = tracker_import(tracker_id=24, tracker_importer_id=63, unique_columns=["Part Number", "Weight"], data=[{"Part Number": "A1", "Weight": 5}, {"Part Number": "A2", "Weight": 8}])
        
        # Import Stage Data
        # If QRONOS_LOGGING enabled then this will create a QRonosImportLog item and return it, otherwise returns None
        import_log = stage_import(stage_id=2, stage_importer_id=25, data=[{"Part Number": "A1", "Lead Time": 5}, {"Part Number": "A2", "Actual": "2020-10-26"}])
        
        # Update (and return) status of a single QRonos Import Log.  Can pass optional qronos parameter if you already have a QRonosClient object.
        status = import_log.update_import_status()
        
        # (Async) Update Status of a set of QRonos Import Logs (note use QRonosImportLog ids, not job ids)
        update_qronos_log_status.delay([125, 233])
        ```
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
