.. image:: https://github.com/2bndy5/rmskin-action/workflows/CI/badge.svg
:target: https://github.com/2bndy5/rmskin-action/actions
.. image:: https://img.shields.io/pypi/v/rmskin-builder.svg
:target: https://pypi.python.org/pypi/rmskin-builder
:alt: latest version on PyPI
.. image:: https://static.pepy.tech/personalized-badge/rmskin-builder?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPi%20Downloads
:target: https://pepy.tech/project/rmskin-builder
:alt: pepy stats
rmskin-action
=============
A Python-based Github action tool to package a Repository's Rainmeter Content into a validating
.rmskin file for Rainmeter's Skin Installer.
.. important::
If the repository contains a RMSKIN.bmp image to used as a header image in the rmskin package,
then it must be using 24-bit colors. Additionally, if the image is not exactly 400x60, then
this action's python script will resize it accordingly.
rmskin-builder Python package
-----------------------------
This action's *rmskin-builder.py* is now also available as a Python executable script via PyPI.
However, it is important that your Python installation's *Scripts* folder is found in your
Operating System's environment variable ``PATH``. If you're using a Python virtual envirnment,
then the *Scripts* folder does not need to be in your Operating System's environment variable
``PATH``.
.. code-block:: shell
pip install rmskin-builder
rmskin-builder.exe --help
Input Arguments
===============
.. csv-table::
:header: "Argument", "Description", "Required"
:widths: 5, 15, 3
"version", "Version of the Rainmeter rmskin package. Defaults to last 8 digits of SHA from commit or ref/tags or otherwise 'x0x.x0xy'.", "no"
"title", "Name of the Rainmeter rmskin package. Defaults to name of repository or otherwise the last directory in the ``path`` argument.", "no"
"author", "Account Username maintaining the rmskin package. Defaults to Username that triggered the action or otherwise 'Unknown'.", "no"
"path", "Base directory of repo being packaged. Defaults to current working path", "no"
"dir_out", "Path to save generated rmskin package. Defaults to current working path", "no"
.. note::
You can use your repository's ``RMSKIN.ini`` file to override any above inputs except ``dir_out`` & ``path`` inputs.
The above arguments are used as CLI arguments to the *rmskin_builder.py* script, but remember to
append the CLI arguments' name with a ``--``. For example, setting the ``path`` argument to use a
relative directory called *tests*:
.. code-block:: shell
rmskin-builder.exe --path tests
Output Arguments
================
* ``arc_name`` : The name of the generated rmskin file saved in the
path specified by ``dir_out`` input argument.
If executing the *rmskin_builder.py* script when not in a Github Action Runner, then this output
argument will show in the script's log output (& not saved anywhere).
Ideal Repo Structure
====================
- root directory
- ``Skins`` a folder to contain all necessary Rainmeter skins
- ``RMSKIN.ini`` list of options specific to installing the skin(s)
- ``Layouts`` a folder that contains Rainmeter layout files
- ``Plugins`` a folder that contains Rainmeter plugins
- ``@Vault`` resources folder accessible by all installed skins
.. tip::
`A cookiecutter repository <https://github.com/2bndy5/Rainmeter-Cookiecutter>`_
has also been created to facilitate development of Rainmeter skins on Github
quickly.
Example Usage
=============
.. code-block:: yaml
name: RMSKIN Packager
on:
push:
pull_request:
release:
types: [published]
jobs:
Build_n_Release:
runs-on: ubuntu-latest
steps:
# Checkout code
- name: Checkout this Repo
uses: actions/checkout@v2
# Runs a rmskin packager action
- name: Run Build action
id: builder
uses: 2bndy5/rmskin-action@v1.1.6
# Upload the asset (using the output from the `builder` step)
- name: Upload Release Asset
if: github.event_name == 'release'
uses: csexton/release-asset-action@master
with:
file: "${{ steps.builder.outputs.arc_name }}"
github-token: ${{ secrets.GITHUB_TOKEN }}
Raw data
{
"_id": null,
"home_page": "https://github.com/2bndy5/rmskin-action",
"name": "rmskin-builder",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "rainmeter rmskin archive builder",
"author": "Brendan Doherty",
"author_email": "2bndy5@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8b/01/7cff2196dbc569c4301690eb4c8a1b9eba61817b6b2da32f35b11cfcbb8a/rmskin-builder-1.1.8.tar.gz",
"platform": null,
"description": "\n.. image:: https://github.com/2bndy5/rmskin-action/workflows/CI/badge.svg\n :target: https://github.com/2bndy5/rmskin-action/actions\n.. image:: https://img.shields.io/pypi/v/rmskin-builder.svg\n :target: https://pypi.python.org/pypi/rmskin-builder\n :alt: latest version on PyPI\n.. image:: https://static.pepy.tech/personalized-badge/rmskin-builder?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPi%20Downloads\n :target: https://pepy.tech/project/rmskin-builder\n :alt: pepy stats\n\nrmskin-action\n=============\n\nA Python-based Github action tool to package a Repository's Rainmeter Content into a validating\n.rmskin file for Rainmeter's Skin Installer.\n\n.. important::\n If the repository contains a RMSKIN.bmp image to used as a header image in the rmskin package,\n then it must be using 24-bit colors. Additionally, if the image is not exactly 400x60, then\n this action's python script will resize it accordingly.\n\nrmskin-builder Python package\n-----------------------------\n\nThis action's *rmskin-builder.py* is now also available as a Python executable script via PyPI.\nHowever, it is important that your Python installation's *Scripts* folder is found in your\nOperating System's environment variable ``PATH``. If you're using a Python virtual envirnment,\nthen the *Scripts* folder does not need to be in your Operating System's environment variable\n``PATH``.\n\n.. code-block:: shell\n\n pip install rmskin-builder\n rmskin-builder.exe --help\n\nInput Arguments\n===============\n\n.. csv-table::\n :header: \"Argument\", \"Description\", \"Required\"\n :widths: 5, 15, 3\n\n \"version\", \"Version of the Rainmeter rmskin package. Defaults to last 8 digits of SHA from commit or ref/tags or otherwise 'x0x.x0xy'.\", \"no\"\n \"title\", \"Name of the Rainmeter rmskin package. Defaults to name of repository or otherwise the last directory in the ``path`` argument.\", \"no\"\n \"author\", \"Account Username maintaining the rmskin package. Defaults to Username that triggered the action or otherwise 'Unknown'.\", \"no\"\n \"path\", \"Base directory of repo being packaged. Defaults to current working path\", \"no\"\n \"dir_out\", \"Path to save generated rmskin package. Defaults to current working path\", \"no\"\n.. note::\n You can use your repository's ``RMSKIN.ini`` file to override any above inputs except ``dir_out`` & ``path`` inputs.\n\nThe above arguments are used as CLI arguments to the *rmskin_builder.py* script, but remember to\nappend the CLI arguments' name with a ``--``. For example, setting the ``path`` argument to use a\nrelative directory called *tests*:\n\n.. code-block:: shell\n\n rmskin-builder.exe --path tests\n\nOutput Arguments\n================\n\n* ``arc_name`` : The name of the generated rmskin file saved in the\n path specified by ``dir_out`` input argument.\n\nIf executing the *rmskin_builder.py* script when not in a Github Action Runner, then this output\nargument will show in the script's log output (& not saved anywhere).\n\nIdeal Repo Structure\n====================\n\n- root directory\n\n - ``Skins`` a folder to contain all necessary Rainmeter skins\n - ``RMSKIN.ini`` list of options specific to installing the skin(s)\n - ``Layouts`` a folder that contains Rainmeter layout files\n - ``Plugins`` a folder that contains Rainmeter plugins\n - ``@Vault`` resources folder accessible by all installed skins\n\n.. tip::\n `A cookiecutter repository <https://github.com/2bndy5/Rainmeter-Cookiecutter>`_\n has also been created to facilitate development of Rainmeter skins on Github\n quickly.\n\nExample Usage\n=============\n\n.. code-block:: yaml\n\n name: RMSKIN Packager\n\n on:\n push:\n pull_request:\n release:\n types: [published]\n\n jobs:\n Build_n_Release:\n runs-on: ubuntu-latest\n\n steps:\n # Checkout code\n - name: Checkout this Repo\n uses: actions/checkout@v2\n\n # Runs a rmskin packager action\n - name: Run Build action\n id: builder\n uses: 2bndy5/rmskin-action@v1.1.6\n\n # Upload the asset (using the output from the `builder` step)\n - name: Upload Release Asset\n if: github.event_name == 'release'\n uses: csexton/release-asset-action@master\n with:\n file: \"${{ steps.builder.outputs.arc_name }}\"\n github-token: ${{ secrets.GITHUB_TOKEN }}\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A script that will attempt to assemble a validating Rainmeter skin package for quick and easy distibution on Github.",
"version": "1.1.8",
"split_keywords": [
"rainmeter",
"rmskin",
"archive",
"builder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b017cff2196dbc569c4301690eb4c8a1b9eba61817b6b2da32f35b11cfcbb8a",
"md5": "901f7b8cc79f8874ae268812f8b7cf39",
"sha256": "5b20f1eb48246890e362242a087e391a5601346d4c1796ca3549644b3696626e"
},
"downloads": -1,
"filename": "rmskin-builder-1.1.8.tar.gz",
"has_sig": false,
"md5_digest": "901f7b8cc79f8874ae268812f8b7cf39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 197022,
"upload_time": "2023-01-14T00:34:23",
"upload_time_iso_8601": "2023-01-14T00:34:23.892251Z",
"url": "https://files.pythonhosted.org/packages/8b/01/7cff2196dbc569c4301690eb4c8a1b9eba61817b6b2da32f35b11cfcbb8a/rmskin-builder-1.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-14 00:34:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "2bndy5",
"github_project": "rmskin-action",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "rmskin-builder"
}
JSON
