Skip to main content

Official stlib plugins

Project description

Official stlib plugins

build status Quality GitHub license

Current plugins:

  • SteamTrades
  • SteamGifts

How to Create Plugins

Just create a new class by extending the class utils.Base from stlib.
Nothing special here, you can use stlib-plugins as an example.

How to Use Plugins

from stlib import plugins

# You can modify the default search path prior the plugin manager initialization
# Must be called before use any method from 'plugins' module
# Warning: Your custom search paths will take precedence over default search paths
plugins.add_search_paths(<mypath>, <anotherpath>, ...)

# You can get a list of all available plugins
all_plugins = plugins.get_available_plugins()

# You can check if there has a plugin called <plugin_name>
if plugins.has_plugin(<plugin_name>):
   # So you can load the plugin by plugin name
   plugin = plugins.get_plugin(<plugin_name>)

Default search paths are:

# For Windows:
<current_directory>\\plugins  
%LOCALAPPDATA%\\stlib\\plugins

# For Linux:
<current_directory>/plugins  
/usr/share/stlib/plugins  
$HOME/.local/share/stlib/plugins

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

stlib-plugins-1.2.3.tar.gz (6.7 kB view hashes)

Uploaded Source

Built Distribution

stlib_plugins-1.2.3-py3-none-any.whl (7.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page