G3W Suite Configuration Scripts

0.6.3 verified Sat May 09 auth: no python

Configuration scripts for setting up the G3W Suite environment. Version 0.6.3 supports Python >=3.7, with monthly releases. Provides utilities for managing g3w-suite configurations.

pip install g3wsuite-config-scripts

Common errors

error ModuleNotFoundError: No module named 'g3wsuite-config-scripts' ↓

cause Trying to import using hyphens instead of underscores.

fix

Change import to: from g3wsuite_config_scripts import ...

error AttributeError: module 'g3wsuite_config_scripts' has no attribute 'run_legacy_setup' ↓

cause Function removed after deprecation in version 0.6.0.

fix

Use ConfigScript.run() instead.

error KeyError: 'G3WSUITE_HOME' ↓

cause Required environment variable G3WSUITE_HOME is not set.

fix

Set the environment variable, e.g., export G3WSUITE_HOME=/path/to/g3wsuite

Warnings

gotcha The package name on PyPI uses hyphens (g3wsuite-config-scripts), but imports use underscores (g3wsuite_config_scripts). Common mistake: using hyphens in import. ↓

fix Use 'from g3wsuite_config_scripts import ...' with underscores.

gotcha Scripts may require specific environment variables to be set before execution. Missing variables can cause silent failures. ↓

fix Ensure all required environment variables as per documentation are set.

deprecated The function 'run_legacy_setup' was deprecated in version 0.6.0 and may be removed. Use 'ConfigScript.run()' instead. ↓

fix Replace 'run_legacy_setup()' with 'ConfigScript().run()'.

Imports

ConfigScript

from g3wsuite_config_scripts import ConfigScript

setup_environment

from g3wsuite_config_scripts import setup_environment

Quickstart

Basic usage: import ConfigScript and call run().

from g3wsuite_config_scripts import ConfigScript

config = ConfigScript()
config.run()