Quick Start - Baselinr
Description: Baselinr - Get started in minutes with data profiling and drift detection

# Get Started in Minutes

Follow this quick guide to install Baselinr and start profiling your databases. You'll be up and running in less than 5 minutes.

### ✓ Requirements

- Python 3.10 or higher
- One of: PostgreSQL, Snowflake, SQLite, MySQL, BigQuery, or Redshift

1
Install Baselinr

Install the package using pip. This will download Baselinr and all required dependencies.

bash

    pip install baselinr

Optional: Install with additional features: `pip install baselinr[snowflake]` or `pip install baselinr[all]`

2
Create Configuration File

Create a `config.yml` file with your database connection and profiling targets.

yaml

    environment: development

    source:
      type: postgres
      host: localhost
      port: 5432
      database: mydb
      username: user
      password: password
      schema: public

    storage:
      connection:
        type: postgres
        host: localhost
        port: 5432
        database: mydb
        username: user
        password: password
      results_table: baselinr_results
      runs_table: baselinr_runs
      create_tables: true

    profiling:
      tables:
        - table: customers
          sample_ratio: 1.0
        - table: orders
          sample_ratio: 1.0

      default_sample_ratio: 1.0
      compute_histograms: true
      histogram_bins: 10

See full example configurations for other database types.

3
Start Profiling

Preview, profile, and detect drift with simple commands:

bash

    # Preview what will be profiled
    baselinr plan --config config.yml

bash

    # Run profiling
    baselinr profile --config config.yml

bash

    # Detect drift (after multiple runs)
    baselinr drift --config config.yml --dataset customers

## What's Next?

### Full Documentation

→

Explore comprehensive guides, API references, and best practices.

### Explore Features

→

Discover all the powerful features Baselinr has to offer.

### View on GitHub

→

Check out the source code, report issues, and contribute.

## Need Help?

Join our community or check out the full documentation for detailed guides and examples.

View Full Documentation Back to Home