widgetastic.patternfly5


Namewidgetastic.patternfly5 JSON
Version 24.4.15.0 PyPI version JSON
download
home_pageNone
SummaryPatternfly5 widget library for Widgetastic.
upload_time2024-04-15 11:45:56
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseCopyright 2023 Red Hat, Inc. and/or its affiliates Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
keywords patternfly patternfly5 widgetastic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center"> widgetastic.patternfly5 </h1>

<p align="center">
    <a href="https://pypi.org/project/widgetastic.patternfly5/">
    <img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/widgetastic.patternfly5.svg?style=flat">
    </a>
    <a href="https://pypi.org/project/widgetastic.patternfly5/#history">
    <img alt="PyPI version" src="https://badge.fury.io/py/widgetastic.patternfly5.svg">
    </a>
    <a href="https://codecov.io/github/RedHatQE/widgetastic.patternfly5">
      <img src="https://codecov.io/github/RedHatQE/widgetastic.patternfly5/graph/badge.svg?token=cWuTXniIPm"/>
    </a>
    <a href="https://github.com/RedHatQE/widgetastic.patternfly5/actions/workflows/tests.yaml">
    <img alt="github actions" src="https://github.com/RedHatQE/widgetastic.patternfly5/actions/workflows/tests.yaml/badge.svg">
    </a>
    <a href="https://pypi.org/project/black">
    <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
    </a>
    <a href="https://results.pre-commit.ci/latest/github/RedHatQE/widgetastic.patternfly5/main">
    <img alt="pre: black" src="https://results.pre-commit.ci/badge/github/RedHatQE/widgetastic.patternfly5/main.svg">
    </a>
</p>

This library offers Widgetastic Widgets for [PatternFly v5](https://www.patternfly.org/), serving as an extended
itteration of [widgetastic.patternfly4](https://github.com/RedHatQE/widgetastic.patternfly4).


### Components:
- [alert](https://www.patternfly.org/components/alert)
- [breadcrumb](https://www.patternfly.org/components/breadcrumb)
- [button](https://www.patternfly.org/components/button)
- [card](https://www.patternfly.org/components/card)
- [chip](https://www.patternfly.org/components/chip)
- [clipboard-copy](https://www.patternfly.org/components/clipboard-copy)
- date and time
  - [calendar-month](https://www.patternfly.org/components/date-and-time/calendar-month)
- [description-list](https://www.patternfly.org/components/description-list)
- [drawer](https://www.patternfly.org/components/drawer)
- [dual-list-selector](https://www.patternfly.org/components/dual-list-selector)
- [expandable-section](https://www.patternfly.org/components/expandable-section)
- forms
  - [form-select](https://www.patternfly.org/components/forms/form-select)
  - [radio](https://www.patternfly.org/components/forms/radio)
- menus
  - [dropdown](https://www.patternfly.org/components/menus/dropdown)
  - [menu](https://www.patternfly.org/components/menus/menu)
  - [menu-toggle](https://www.patternfly.org/components/menus/menu-toggle)
  - [options-menu](https://www.patternfly.org/components/menus/options-menu/)
  - [select](https://www.patternfly.org/components/menus/select)
  - [typeahedselect](https://www.patternfly.org/components/menus/select/#typeahead)
- [modal](https://www.patternfly.org/components/modal)
- [navigation](https://www.patternfly.org/components/navigation)
- [pagination](https://www.patternfly.org/components/pagination/)
- [popover](https://www.patternfly.org/components/popover)
- [progress](https://www.patternfly.org/components/progress)
- [slider](https://www.patternfly.org/components/slider)
- [switch](https://www.patternfly.org/components/switch)
- [table](https://www.patternfly.org/components/table)
- [tabs](https://www.patternfly.org/components/tabs)
- [title](https://www.patternfly.org/components/title)


### Charts:
- [bullet-chart](https://www.patternfly.org/charts/bullet-chart)
- [donut-chart](https://www.patternfly.org/charts/donut-chart)
- [legends](https://www.patternfly.org/charts/legends)
- [line-chart](https://www.patternfly.org/charts/line-chart)
- [pie-chart](https://www.patternfly.org/charts/pie-chart)

### Patterns:
- [card-view](https://patternfly-react-main.surge.sh/patterns/card-view)


### Contribution guide

```bash
# clone the repo
git clone https://github.com/RedHatQE/widgetastic.patternfly5.git
cd widgetastic.patternfly5

# create a virtual environment
python3 -m venv .venv_pfy5
source .venv_pfy5/bin/activate

# update pip and its friends
pip install -U pip setuptools wheel

# install the package in editable mode
pip install -e .[dev]
pre-commit install
```

### Testing

The library has selenium tests that are performed against [Patternfly React docs](https://patternfly-react-main.surge.sh).
It's also configured to run the tests every time when a new version of that page is released.

Tests spawn a container from official selenium image - [selenium/standalone-{chrome/firefox}](https://hub.docker.com/u/selenium).
We can check local runs via vnc `http://localhost:7900`

**Note:** Tests use `podman` to manage containers. Please install it before running.

It's possible to run tests in parallel to speed up the execution. Make sure that you have **xdist** python plugin installed.

Use `-n` key to specify a number
of workers:

```bash
BROWSER=firefox pytest -v testing -n 4
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "widgetastic.patternfly5",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Nikhil Dhandre <ndhandre@redhat.com>, Egor Shamardin <eshamard@redhat.com>, Mike Shriver <mshriver@redhat.com>",
    "keywords": "patternfly, patternfly5, widgetastic",
    "author": null,
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "<h1 align=\"center\"> widgetastic.patternfly5 </h1>\n\n<p align=\"center\">\n    <a href=\"https://pypi.org/project/widgetastic.patternfly5/\">\n    <img alt=\"Python Versions\" src=\"https://img.shields.io/pypi/pyversions/widgetastic.patternfly5.svg?style=flat\">\n    </a>\n    <a href=\"https://pypi.org/project/widgetastic.patternfly5/#history\">\n    <img alt=\"PyPI version\" src=\"https://badge.fury.io/py/widgetastic.patternfly5.svg\">\n    </a>\n    <a href=\"https://codecov.io/github/RedHatQE/widgetastic.patternfly5\">\n      <img src=\"https://codecov.io/github/RedHatQE/widgetastic.patternfly5/graph/badge.svg?token=cWuTXniIPm\"/>\n    </a>\n    <a href=\"https://github.com/RedHatQE/widgetastic.patternfly5/actions/workflows/tests.yaml\">\n    <img alt=\"github actions\" src=\"https://github.com/RedHatQE/widgetastic.patternfly5/actions/workflows/tests.yaml/badge.svg\">\n    </a>\n    <a href=\"https://pypi.org/project/black\">\n    <img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n    </a>\n    <a href=\"https://results.pre-commit.ci/latest/github/RedHatQE/widgetastic.patternfly5/main\">\n    <img alt=\"pre: black\" src=\"https://results.pre-commit.ci/badge/github/RedHatQE/widgetastic.patternfly5/main.svg\">\n    </a>\n</p>\n\nThis library offers Widgetastic Widgets for [PatternFly v5](https://www.patternfly.org/), serving as an extended\nitteration of [widgetastic.patternfly4](https://github.com/RedHatQE/widgetastic.patternfly4).\n\n\n### Components:\n- [alert](https://www.patternfly.org/components/alert)\n- [breadcrumb](https://www.patternfly.org/components/breadcrumb)\n- [button](https://www.patternfly.org/components/button)\n- [card](https://www.patternfly.org/components/card)\n- [chip](https://www.patternfly.org/components/chip)\n- [clipboard-copy](https://www.patternfly.org/components/clipboard-copy)\n- date and time\n  - [calendar-month](https://www.patternfly.org/components/date-and-time/calendar-month)\n- [description-list](https://www.patternfly.org/components/description-list)\n- [drawer](https://www.patternfly.org/components/drawer)\n- [dual-list-selector](https://www.patternfly.org/components/dual-list-selector)\n- [expandable-section](https://www.patternfly.org/components/expandable-section)\n- forms\n  - [form-select](https://www.patternfly.org/components/forms/form-select)\n  - [radio](https://www.patternfly.org/components/forms/radio)\n- menus\n  - [dropdown](https://www.patternfly.org/components/menus/dropdown)\n  - [menu](https://www.patternfly.org/components/menus/menu)\n  - [menu-toggle](https://www.patternfly.org/components/menus/menu-toggle)\n  - [options-menu](https://www.patternfly.org/components/menus/options-menu/)\n  - [select](https://www.patternfly.org/components/menus/select)\n  - [typeahedselect](https://www.patternfly.org/components/menus/select/#typeahead)\n- [modal](https://www.patternfly.org/components/modal)\n- [navigation](https://www.patternfly.org/components/navigation)\n- [pagination](https://www.patternfly.org/components/pagination/)\n- [popover](https://www.patternfly.org/components/popover)\n- [progress](https://www.patternfly.org/components/progress)\n- [slider](https://www.patternfly.org/components/slider)\n- [switch](https://www.patternfly.org/components/switch)\n- [table](https://www.patternfly.org/components/table)\n- [tabs](https://www.patternfly.org/components/tabs)\n- [title](https://www.patternfly.org/components/title)\n\n\n### Charts:\n- [bullet-chart](https://www.patternfly.org/charts/bullet-chart)\n- [donut-chart](https://www.patternfly.org/charts/donut-chart)\n- [legends](https://www.patternfly.org/charts/legends)\n- [line-chart](https://www.patternfly.org/charts/line-chart)\n- [pie-chart](https://www.patternfly.org/charts/pie-chart)\n\n### Patterns:\n- [card-view](https://patternfly-react-main.surge.sh/patterns/card-view)\n\n\n### Contribution guide\n\n```bash\n# clone the repo\ngit clone https://github.com/RedHatQE/widgetastic.patternfly5.git\ncd widgetastic.patternfly5\n\n# create a virtual environment\npython3 -m venv .venv_pfy5\nsource .venv_pfy5/bin/activate\n\n# update pip and its friends\npip install -U pip setuptools wheel\n\n# install the package in editable mode\npip install -e .[dev]\npre-commit install\n```\n\n### Testing\n\nThe library has selenium tests that are performed against [Patternfly React docs](https://patternfly-react-main.surge.sh).\nIt's also configured to run the tests every time when a new version of that page is released.\n\nTests spawn a container from official selenium image - [selenium/standalone-{chrome/firefox}](https://hub.docker.com/u/selenium).\nWe can check local runs via vnc `http://localhost:7900`\n\n**Note:** Tests use `podman` to manage containers. Please install it before running.\n\nIt's possible to run tests in parallel to speed up the execution. Make sure that you have **xdist** python plugin installed.\n\nUse `-n` key to specify a number\nof workers:\n\n```bash\nBROWSER=firefox pytest -v testing -n 4\n```\n",
    "bugtrack_url": null,
    "license": "Copyright 2023 Red Hat, Inc. and/or its affiliates  Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
    "summary": "Patternfly5 widget library for Widgetastic.",
    "version": "24.4.15.0",
    "project_urls": {
        "repository": "https://github.com/RedHatQE/widgetastic.patternfly5"
    },
    "split_keywords": [
        "patternfly",
        " patternfly5",
        " widgetastic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5a4b1c55db6af69dd6c3de803bd62a04947888a117a9b533dd8cbfa742de16b2",
                "md5": "8af102701a4e41606aa7413de9fec41a",
                "sha256": "5b07c0d9322eacf7754f9d4143980d705fed83c769619b88266c62e2049eb89a"
            },
            "downloads": -1,
            "filename": "widgetastic.patternfly5-24.4.15.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8af102701a4e41606aa7413de9fec41a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 52086,
            "upload_time": "2024-04-15T11:45:56",
            "upload_time_iso_8601": "2024-04-15T11:45:56.858065Z",
            "url": "https://files.pythonhosted.org/packages/5a/4b/1c55db6af69dd6c3de803bd62a04947888a117a9b533dd8cbfa742de16b2/widgetastic.patternfly5-24.4.15.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-15 11:45:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "RedHatQE",
    "github_project": "widgetastic.patternfly5",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "widgetastic.patternfly5"
}
        
Elapsed time: 0.34861s