Skip to main content

Universal Sales Intelligence Engine — drop in any dataset, get standardized reports

Project description

salesengine

Universal Sales Intelligence Engine — Drop in any sales dataset, answer a short questionnaire, get standardized executive-ready reports. Works across industries.

Install

pip install salesengine

For statistical tests (chi-squared, Cramér's V):

pip install salesengine[stats]

Quick Start

Two-step workflow

import salesengine as se

# Step 1: Scan your data → generates a JSON questionnaire
se.scan("sales_data.csv")

# Step 2: Fill in the JSON, then run
se.run("sales_data.csv", "sales_data_intake.json")

Command line

salesengine scan sales_data.csv
salesengine run sales_data.csv sales_data_intake.json

Use individual functions

from salesengine import clean_numeric, classify_customer_movement, weighted_average

# Clean messy financial data
df['Revenue'] = clean_numeric(df['Revenue'])  # handles $, commas, (negatives), N/A

# Analyze customer churn with 4-level classification
movement = classify_customer_movement(
    current_customers=set(df_current['ID']),
    prior_customers=set(df_prior['ID']),
)
# Returns: left_entirely, left_segment, migrated_out, new_acquisition, retained

How It Works

1. Scan → Auto-detect columns

The scanner reads your CSV/Excel and matches columns to 33 logical field names using pattern matching against 100+ common naming conventions.

2. Questionnaire → Define your business

A JSON questionnaire with 5 sections:

  • Business Context — industry, units, currency
  • Field Mapping — confirm auto-detected columns
  • Business Rules — what is "lost customer"? what is "good lead"?
  • Thresholds — numeric cutoffs for your industry
  • Report Preferences — toggle analyses on/off

3. Config → Power the functions

Your answers become a ProjectConfig that maps logical names to your column names. Functions that need missing fields auto-skip.

4. Report → Formatted Excel

12+ tab workbook with executive summary, volume/revenue/margin breakdowns, customer churn, segment comparisons, and customer rankings.

Cross-Industry

Same code, different config:

Industry "Customer" "Volume" "Affinity"
Food Distribution Restaurant Pounds Cuisine type
SaaS Account MRR Industry vertical
Healthcare Provider Procedures Specialty
Retail Store Units sold Department
Manufacturing Distributor Cases End-use

22 Functions in 9 Categories

Category Functions
Data Cleaning clean_numeric, clean_currency, clean_dataframe
Statistical Analysis cramers_v, gini_coefficient, run_statistical_summary
Weighted Aggregation weighted_average, aggregate_to_grain
Customer & Churn classify_customer_movement, identify_non_buyers
Index / Benchmark calculate_price_index, classify_index, detect_index_conflicts
Confidence score_confidence, classify_confidence_band
Banding / Tiering assign_band, calculate_priority_score
Excel Formatting get_excel_styles, style_header_row, auto_width, df_to_sheet
File Inspection inspect_csv

Configuration

from salesengine import ProjectConfig, set_global_config

cfg = ProjectConfig(
    project_name="Q1 Review",
    industry="SaaS"
)
cfg.fields['customer_id'] = 'Account_ID'
cfg.fields['volume_cy'] = 'MRR_Current'
cfg.fields['segment'] = 'Plan_Tier'

# Disable functions you don't need
cfg.disabled_functions.add('calculate_price_index')

# Adjust thresholds
cfg.index_thresholds = {'extreme_high': 2.0, 'high': 1.20, 'low': 0.80}

set_global_config(cfg)

License

MIT

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

salesengine-0.3.0.tar.gz (48.2 kB view details)

Uploaded Source

Built Distribution

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

salesengine-0.3.0-py3-none-any.whl (53.2 kB view details)

Uploaded Python 3

File details

Details for the file salesengine-0.3.0.tar.gz.

File metadata

  • Download URL: salesengine-0.3.0.tar.gz
  • Upload date:
  • Size: 48.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for salesengine-0.3.0.tar.gz
Algorithm Hash digest
SHA256 52a156b6933a84ac6082543356b0c933e1fb5e3c8a9a7bceebb7dc9239e9f5b1
MD5 11a5d4a3391960dd322532e9cce97723
BLAKE2b-256 88d2e1d6a7f60912319ec614c54373fa5a6fcdd680f4718c31ffa0b41ac58018

See more details on using hashes here.

File details

Details for the file salesengine-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: salesengine-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 53.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for salesengine-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62820f5a5c81ce06f59f5e9d60aa1f402a891ca1271a547bc37915806669ecff
MD5 1cbbb095a7f98c5b461acc77a61a327c
BLAKE2b-256 bd49a3e3e76e1c04ee375017cc450277047d1ae0fc265db890ce57a5fea34bc3

See more details on using hashes here.

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