Metadata-Version: 2.1
Name: autobricks
Version: 0.0.2
Summary: Databricks Deployment Utils
Home-page: https://autobricks.readthedocs.io/en/latest/
Author: Shaun Ryan
Author-email: shaun_chiburi@hotmail.com
License: MIT
Description: # Documentation
        
        https://autobricks.readthedocs.io/en/latest/
        
        # Development Setup
        
        Create virual environment and install dependencies for local development:
        
        ```
        python3.7 -m venv venv
        source venv/bin/activate
        pip install --upgrade pip
        pip install -r requirements.txt
        pip install -r dev_requirements.txt
        ```
        
        The application requires the following environment variables specific the databricks workspace and security token that you're using for testing, development and deployment. Substitute your own values between the angled brackets:
        
        ```
        export DBUTILSTOKEN="<my_token>"
        export DATABRICKS_API_HOST="https://<my_databricks_host>.azuredatabricks.net"
        ```
        
        Exporting variables doesn't make for a great development experience so I recommend using the enviroment manager tools of your editor and for testing create a ./pytest.ini that looks like this:
        
        ```
        [pytest]
        env =
            DATABRICKS_API_HOST=https://<my_databricks_host>.azuredatabricks.net
            DBUTILSTOKEN=<my_token>
        ```
        
        **REMINDER: do NOT commit any files that contain security tokens**
        
        Git ignore already contains an exclusion for pytest.ini
        
        
        # Build
        
        Build python wheel:
        ```
        python setup.py sdist bdist_wheel
        ```
        
        There is a CI build configured for this repo that builds on main origin on a private Azure DevOps service. It doesn't yet push to PyPi.
        
        # Test
        
        Dependencies for testing:
        ```
        pip install --editable .
        ```
        
        Run tests:
        ```
        pytest
        ```
        
        Test Coverage:
        ```
        pytest --cov=autobricks --cov-report=html
        ```
        
        View the report in a browser:
        ```
        ./htmlcov/index.html
        ```
        
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
