brahm-centre-utils 0.1.0

Brahm Centre internal utility functions

bc-utils-package

init.py: This file will be run at the initialization. It will retrieve functions for quick function calling. Instead of "from bc_utils.salesforce import query_salesforce", it can be "from bc_utils import query_salesforce"

Brahm-centre-utils

Brahm-centre-utils is a collection of internal utility functions designed to facilitate common tasks at Brahm Centre. This package includes functions for Salesforce interactions, data processing, and more.

Installation

To install Brahm-centre-utils, you need to have pip and virtualenv set up on your system.

Using pip from a local directory

1. Clone the repository or download the package to your local machine.
2. Navigate to the project directory.
3. Run the following command to install the package:

pip install /path/to/BC-UTILS-PACKAGE

Editable Mode (for development)

If you are developing the package and want changes to be immediately reflected in your projects:

pip install -e /path/to/BC-UTILS-PACKAGE

Usage

After installing the package, you can use the functions provided by Brahm-centre-utils in your projects. Below are some examples.

Salesforce Integration

query_salesforce

This function allows you to query Salesforce data using SOQL (Salesforce Object Query Language).

Example:

from salesforce import query_salesforce

# Use the function to query Salesforce
result = query_salesforce("SELECT Id, Name FROM Account")
print(result)

get_Id_from_SF_URL

This function extracts the Salesforce ID from a given Salesforce URL.

Example:

from salesforce import get_Id_from_SF_URL

# Extract Salesforce ID from URL
sf_id = get_Id_from_SF_URL("https://example.my.salesforce.com/0015g00000WvXXq")
print(sf_id)

Common Utilities

normalize_name

This function normalizes a given name by converting it to lowercase and removing extra spaces.

Example:

from common import normalize_name

# Normalize a name
name = normalize_name(" John Doe ")
print(name)  # Output: "john doe"

Full List of Functions

• salesforce.query_salesforce
• salesforce.get_Id_from_SF_URL
• common.normalize_name
• common.are_names_similar
• common.get_unique_names

Configuration

Brahm-centre-utils requires certain environment variables for Salesforce integration. These should be stored in a .env file in the root of your project.

Example .env file

SF_USERNAME=your_salesforce_username
SF_PASSWORD=your_salesforce_password
SF_TOKEN=your_salesforce_security_token
SF_DOMAIN=your_salesforce_domain

Loading Environment Variables

Ensure that you load the environment variables at the start of your script.

from dotenv import load_dotenv
load_dotenv()