stlib-plugins


Namestlib-plugins JSON
Version 1.2.3 PyPI version JSON
download
home_page
SummaryOfficial stlib plugins
upload_time2023-07-20 22:09:55
maintainer
docs_urlNone
authorLara Maia
requires_python>=3.9
licenseGPLv3
keywords steam-tools steam stlib valve
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            Official stlib plugins
======================

[![build status](https://badges.lara.monster/calendulish/.github/stlib-plugins-build)](https://github.com/calendulish/stlib-plugins/actions/workflows/build.yml)
[![Quality](https://api.codiga.io/project/34835/score/svg)](https://app.codiga.io/hub/project/34835/stlib-plugins)
[![GitHub license](https://img.shields.io/badge/license-GPLv3-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html)

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
==================

```python
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:

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

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

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "stlib-plugins",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "steam-tools,steam,stlib,valve",
    "author": "Lara Maia",
    "author_email": "dev@lara.monster",
    "download_url": "https://files.pythonhosted.org/packages/28/0a/7b9044f55336f2a0382ebbaa8e4512690de09977c37dc118e5f2c6c4bd92/stlib-plugins-1.2.3.tar.gz",
    "platform": null,
    "description": "Official stlib plugins\n======================\n\n[![build status](https://badges.lara.monster/calendulish/.github/stlib-plugins-build)](https://github.com/calendulish/stlib-plugins/actions/workflows/build.yml)\n[![Quality](https://api.codiga.io/project/34835/score/svg)](https://app.codiga.io/hub/project/34835/stlib-plugins)\n[![GitHub license](https://img.shields.io/badge/license-GPLv3-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html)\n\nCurrent plugins:\n\n- SteamTrades\n- SteamGifts\n\nHow to Create Plugins\n=====================\n\nJust create a new class by extending the class `utils.Base` from `stlib`.  \nNothing special here, you can use stlib-plugins as an example.\n\nHow to Use Plugins\n==================\n\n```python\nfrom stlib import plugins\n\n# You can modify the default search path prior the plugin manager initialization\n# Must be called before use any method from 'plugins' module\n# Warning: Your custom search paths will take precedence over default search paths\nplugins.add_search_paths(<mypath>, <anotherpath>, ...)\n\n# You can get a list of all available plugins\nall_plugins = plugins.get_available_plugins()\n\n# You can check if there has a plugin called <plugin_name>\nif plugins.has_plugin(<plugin_name>):\n   # So you can load the plugin by plugin name\n   plugin = plugins.get_plugin(<plugin_name>)\n```\n\nDefault search paths are:\n\n```python\n# For Windows:\n<current_directory>\\\\plugins  \n%LOCALAPPDATA%\\\\stlib\\\\plugins\n\n# For Linux:\n<current_directory>/plugins  \n/usr/share/stlib/plugins  \n$HOME/.local/share/stlib/plugins\n```\n",
    "bugtrack_url": null,
    "license": "GPLv3",
    "summary": "Official stlib plugins",
    "version": "1.2.3",
    "project_urls": {
        "changelog": "https://github.com/calendulish/stlib-plugins/releases",
        "homepage": "https://github.com/calendulish/stlib-plugins",
        "repository": "https://github.com"
    },
    "split_keywords": [
        "steam-tools",
        "steam",
        "stlib",
        "valve"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3ded95b960d8ed99e5405944904b2845d7731486cbc9706faeef12db61a2b157",
                "md5": "b464df32bd5f5b9657128a28822c64d4",
                "sha256": "71a6e6182f0b029797e6d2739ec560fa62fafd80aadadcd48ccfda14170bb070"
            },
            "downloads": -1,
            "filename": "stlib_plugins-1.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b464df32bd5f5b9657128a28822c64d4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 7431,
            "upload_time": "2023-07-20T22:09:54",
            "upload_time_iso_8601": "2023-07-20T22:09:54.152886Z",
            "url": "https://files.pythonhosted.org/packages/3d/ed/95b960d8ed99e5405944904b2845d7731486cbc9706faeef12db61a2b157/stlib_plugins-1.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "280a7b9044f55336f2a0382ebbaa8e4512690de09977c37dc118e5f2c6c4bd92",
                "md5": "6c8c9441e5f2be63f77892d5f56adacb",
                "sha256": "3bb68163e3311369d5c0e904d17e926137e644be316bc81525b958309528f966"
            },
            "downloads": -1,
            "filename": "stlib-plugins-1.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "6c8c9441e5f2be63f77892d5f56adacb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 6700,
            "upload_time": "2023-07-20T22:09:55",
            "upload_time_iso_8601": "2023-07-20T22:09:55.483869Z",
            "url": "https://files.pythonhosted.org/packages/28/0a/7b9044f55336f2a0382ebbaa8e4512690de09977c37dc118e5f2c6c4bd92/stlib-plugins-1.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-20 22:09:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "calendulish",
    "github_project": "stlib-plugins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "stlib-plugins"
}
Lara Maia
Elapsed time: 0.09359s