Metadata-Version: 2.1
Name: cru-dse-utils
Version: 0.1.3
Summary: Cru DSE Python Utils
Author-email: Cru DSE Team <tony.guan@cru.org>
License: MIT License
        
        Copyright (c) [2023] [Cru]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: repository, https://github.com/CruGlobal/dse-python-utils
Project-URL: homepage, https://github.com/CruGlobal/dse-python-utils
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: build
Provides-Extra: dev
License-File: LICENSE


# cru-dse-utils
This is a package of useful functions developed by the Cru Data Sciences & Engineering team. The package includes the following files:

- `general.py`: Contains general data extraction related functions.
- `auth.py`: Contains functions for fetching credentials. 
- `bigquery.py`: Contains functions for bigquery operations.
- `gcs.py`: Contains functions for Google Cloud Storage operations.
- `dbt.py`: Contains functions for dbt operations.

## Installation
To install the package, run the following command:
`pip install cru-dse-utils`

## Usage
To use the package, import the desired functions from the appropriate subfolder. For example:
`from cru_dse_utils import get_request` 

Refer to the function docstring for instructions how to use the functions

## Contributing
If you would like to contribute to the package, please follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes and commit them with descriptive commit messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.

## License
This package is licensed under the MIT License. See the LICENSE file for more information.

