Skip to main content

A utility library that enhances the official BigQuery Python client by providing additional tools for efficient query management, data processing, and automation. Designed for developers and data scientists, `bigquery-advanced-utils` simplifies working with Google BigQuery.

Project description

bigquery-advanced-utils

Total Downloads License Version codecov PyPI Issues Contributors PyLint Black

BigQuery-advanced-utils is a lightweight utility library that extends the official Google BigQuery Python client.
It simplifies tasks like query management, data processing, and automation.

Aimed at developers and data scientists, the project is open to contributions to improve and enhance its functionality.

For full documentation, please visit: BigQuery-Advanced-Utils Documentation

Why This Library?

I created bigquery-advanced-utils because I often found myself facing complex or uncommon tasks when working with BigQuery, and there was little or no support available online. Rather than spending time reinventing the wheel, I decided to create this library to help others avoid the same challenges. I hope that everyone can contribute in the same spirit, so feel free to get involved and make this library even better!

Requirements

  • Python 3.10+

Installation 📦

Install via pip (recommended)

Run the following command in your terminal:

pip install bigquery-advanced-utils

Install in a Virtual Environment

  1. Create a virtual environment:
python -m venv venv
  1. Activate the environment and install:
source venv/bin/activate  # on macOS/Linux  
venv\Scripts\activate     # on Windows  
pip install bigquery-advanced-utils

Usage Examples 🚀

Quick Start

from bigquery_advanced_utils.bigquery import BigQueryClient

# Initialize helper with your project ID
helper = BigQueryClient(project_id="your_project_id")

# Load data from CSV
helper.load_data_from_csv(file_path="your_data.csv")

Data Validation

test_functions=[
    partial(
        # Check if any null values exist in the "age" column
        b.check_no_nulls, columns_to_test=["age"],
    ),
    partial(
        # Ensure values in the "email" column are unique
        b.check_unique_column, columns_to_test=["email"]
    )
]

Search by table or owner in Datatransfer

from bigquery_advanced_utils.datatransfer import DataTransferClient

helper = DataTransferClient()
# Call the function with two parameters: owner email and project id
list_transfer_config_by_owner_email(owner_email="my-email@email.com", project_id="my-project")

# Get the scheduled queries by the name of a table (it's case sensitive) 
list_transfer_configs_by_table(table_id="my-table", project_id="my-project")

Planned features 🚧

  • A new query builder.
  • Custom data transformation and processing functions.
  • Exclusive features with datatransfer.
  • Utility functions to manipulate strings and query.

Contributing

We are always open to contributions! Whether you have a bug fix, a feature request, or a general improvement to make, your help is appreciated. Here are some ways you can contribute:

  • Bug reports: Help us catch issues before they affect users.
  • New features: Suggest new functionalities that could improve the usability of the package.
  • Code improvements: Review the code and suggest optimizations or fixes.

Please follow the contributing guide for more details on how to get started.

License

This project is licensed under the GNU General Public License. See the LICENSE file for details.

Contact

For questions or feedback, feel free to open an issue or reach out to me.

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

bigquery_advanced_utils-0.0.1.dev6.tar.gz (61.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bigquery_advanced_utils-0.0.1.dev6-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file bigquery_advanced_utils-0.0.1.dev6.tar.gz.

File metadata

File hashes

Hashes for bigquery_advanced_utils-0.0.1.dev6.tar.gz
Algorithm Hash digest
SHA256 6ae658968d7f700b5abd96081819a480e59d21e4a8979baea90dc519d80f5be1
MD5 a93921584e4fcde216b14871874a86a0
BLAKE2b-256 2d5bf400dc11977454a9b15b839eb96ea5444527151fec83f74d835bdebc317e

See more details on using hashes here.

Provenance

The following attestation bundles were made for bigquery_advanced_utils-0.0.1.dev6.tar.gz:

Publisher: publish-to-pypi.yml on Alessio-Siciliano/bigquery-advanced-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bigquery_advanced_utils-0.0.1.dev6-py3-none-any.whl.

File metadata

File hashes

Hashes for bigquery_advanced_utils-0.0.1.dev6-py3-none-any.whl
Algorithm Hash digest
SHA256 ea739023c70b3e486074969cefd2a13ce491217fc943896622a872b2b9234018
MD5 592e6e2a7d2561be63572ed800dd7613
BLAKE2b-256 746aa9cdca7a5597f6d19fa394c5f8226bf082ca07dd9270c3e848fda0777a2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for bigquery_advanced_utils-0.0.1.dev6-py3-none-any.whl:

Publisher: publish-to-pypi.yml on Alessio-Siciliano/bigquery-advanced-utils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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