Skip to main content

SSRS Library

Project description

SSRS Python Tools

A modern Python library to replace the PowerShell ReportingServicesTools module, designed for automation and CI/CD pipelines (e.g., GitLab CI/CD).

Repository: ipierre1/ssrs-powerbi-library
PyPI package: ssrs-powerbi-library


๐Ÿš€ Features

  • Full replacement for PowerShell ReportingServicesTools
  • Native REST API for SQL Server Reporting Services (SSRS)
  • NTLM authentication support (Windows credentials)
  • CI/CD integration (GitLab, GitHub, Azure, etc.)
  • Data source connection testing
  • Report and catalog item management
  • Flexible configuration via environment variables
  • Advanced logging for debugging and monitoring

๐Ÿ“ฆ Installation

# Install from PyPI (recommended)
pip install ssrs-powerbi-library

# Or install from source
git clone https://github.com/ipierre1/ssrs-powerbi-library.git
cd ssrs-powerbi-library
pip install -r requirements.txt
pip install -e .

Requirements

  • Python 3.7+
  • Access to an SSRS server with REST API enabled
  • Credentials for NTLM authentication

๐Ÿ“ Project Structure

ssrs-powerbi-library/
โ”‚
โ”œโ”€โ”€ ssrs_library/
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ ssrs_library.py         # Main client logic
โ”‚   โ”œโ”€โ”€ datasource_manager.py   # Data source management logic
โ”‚   โ””โ”€โ”€ types/
โ”‚       โ”œโ”€โ”€ __init__.py
โ”‚       โ”œโ”€โ”€ rsitemtype.py       # RsItemType enum
โ”‚       โ”œโ”€โ”€ datasourcetype.py   # DataSourceType enum
โ”‚       โ”œโ”€โ”€ rscredentials.py    # Credentials dataclasses
โ”‚       โ”œโ”€โ”€ rsdatasource.py     # RsDataSource dataclass
โ”‚       โ””โ”€โ”€ rsitem.py           # RsItem dataclass
โ”‚
โ”œโ”€โ”€ tests/
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ example_usage.py
โ”œโ”€โ”€ deploy_reports.py
โ”œโ”€โ”€ requirements.txt
โ”œโ”€โ”€ pyproject.toml
โ””โ”€โ”€ README.md

Mermaid Diagram

graph TD
    A[SSRSRestClient] -->|uses| B[SSRSDataSourceManager]
    A -->|uses| C[RsItem]
    B -->|uses| D[RsDataSource]
    D -->|has| E[CredentialsByUser]
    D -->|has| F[CredentialsInServer]
    D -->|has| G[NoCredentials]
    C -->|typed| H[RsItemType]
    D -->|typed| I[DataSourceType]

๐Ÿ”ง Configuration

Environment Variables (for CI/CD)

Set these variables in your CI/CD environment:

SSRS_SERVER_URL=http://your-ssrs-server/reports
SSRS_USERNAME=your-username
SSRS_PASSWORD=your-password
SSRS_DOMAIN=your-domain  # Optional

Python Usage Example

from ssrs_library.ssrs_library import SSRSRestClient

client = SSRSRestClient(
    server_url='http://your-server/reports',
    username='your-username',
    password='your-password',
    domain='your-domain'  # optional
)

# Example: List catalog items in root folder
items = client.get_catalog_items('/')
for item in items:
    print(item.name, item.item_type)

๐Ÿงช Testing

pytest tests/

๐Ÿ“„ License

MIT License

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

ssrs_powerbi_library-1.1.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

ssrs_powerbi_library-1.1.0-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file ssrs_powerbi_library-1.1.0.tar.gz.

File metadata

  • Download URL: ssrs_powerbi_library-1.1.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ssrs_powerbi_library-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ada4581988f59655ea9d926ec526400b17450fc9e64c6abec6935b960548d5b9
MD5 c626e0499b4115cf1c5a44c3db99a331
BLAKE2b-256 3ea576c0b4931938c1644631a48a3adf65f0640ca6952332f1741e524610a803

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssrs_powerbi_library-1.1.0.tar.gz:

Publisher: release.yml on ipierre1/ssrs-powerbi-library

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

File details

Details for the file ssrs_powerbi_library-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ssrs_powerbi_library-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cfd268c7b3ffd3ac1af97009f56ef66ec2585c973624c13691b951c3a5b397b3
MD5 81441873b02754e9dd3518f46ed68cef
BLAKE2b-256 f0af964384f509e56947a5c3837c762588ac3fe77c8583e07d3ab99b37439cf4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssrs_powerbi_library-1.1.0-py3-none-any.whl:

Publisher: release.yml on ipierre1/ssrs-powerbi-library

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