Skip to content

LukeSavefrogs/wsadmin-type-hints

Repository files navigation

Documentation

wsadmin-type-hints

Python package providing type hints for wsadmin Jython commands.

This speeds up the development of wsadmin Jython scripts inside an IDE since it provides intellisense on every method of the 5 main objects provided at runtime by the wsadmin:

  • AdminControl
  • AdminConfig
  • AdminApp
  • AdminTask
  • Help

📚 Read the full documentation

Features

  • List all module commands through intellisense:

    List module commands

  • Check parameter and return types, as well as a brief description of the command (using Google syntax):

    Parameters

Quick start

Download

  • Using pip:

     pip install wsadmin-type-hints
    
  • Using poetry:

     poetry add wsadmin-type-hints --group dev 
    

Usage

Use it like this:

try:
    (AdminControl, AdminConfig, AdminApp, AdminTask, Help)
except NameError:
    from wsadmin_type_hints import AdminControl, AdminConfig, AdminApp, AdminTask, Help
else:
    print("AdminControl is already defined, i'm not needed here 😃")

The try..except block is used to differentiate between the development and production environment.

Disclaimer

This is an unofficial package created for speeding up the development process and is not in any way affiliated with IBM®. All trademarks and registered trademarks are the property of their respective company owners.

The code does not include any implementation detail, and includes only the informations (such as parameter numbers, types and descriptions) publicly available on the official Websphere Application Server® documentation.