civilpy.general.bentley package

Submodules

civilpy.general.bentley.projectwise module

This script provides a library for interacting with the native ProjectWise API (dmscli.dll, dmawin.dll) from Python.

It includes a PW_SESSION context manager to handle safe login/logout, and functions for building an in-memory map of the project structure for fast lookups.

class civilpy.general.bentley.projectwise.PW_SESSION(datasource_name='OhioDOT-pw.bentley.com:OhioDOT-pw-02')

Bases: object

A context manager to handle ProjectWise API login and logout.

Usage:

with PW_SESSION() as s: # Defaults to the ODOT datasource

# Your PW API calls go here pass

__init__(datasource_name='OhioDOT-pw.bentley.com:OhioDOT-pw-02')

Initializes the session with a datasource name.

Parameters:

datasource_name (str, optional) – The datasource to connect to. Defaults to “OhioDOT-pw.bentley.com:OhioDOT-pw-02”.

civilpy.general.bentley.projectwise.build_project_map(max_depth=4)

Builds an in-memory map of the ProjectWise folder structure for fast lookups.

Parameters:

max_depth (int) – How many levels deep to map the folder structure.

Returns:

A tuple containing two dictionaries:

(hierarchical_map, flat_pid_map)

Return type:

tuple

civilpy.general.bentley.projectwise.display_project_properties(properties)

Nicely prints the dictionary of project properties.

civilpy.general.bentley.projectwise.get_project_properties(project_id)

Selects a project and extracts a dictionary of its key metadata.

civilpy.general.bentley.projectwise.get_pw_path()

Finds the ProjectWise installation path by searching the Windows Registry.

civilpy.general.bentley.projectwise.get_user_name(user_id)

Helper function to retrieve a user’s name from their ID.

civilpy.general.bentley.projectwise.load_pw_dlls()

Finds the PW bin directory and loads the necessary DLLs, defining function prototypes.

Module contents