{
    "info": {
        "author": "Peter Volf",
        "author_email": "do.volfp@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3 :: Only",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: 3.8",
            "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
            "Topic :: Software Development :: Code Generators",
            "Topic :: Software Development :: Libraries :: Python Modules",
            "Topic :: Text Processing :: Markup :: HTML",
            "Topic :: Utilities",
            "Typing :: Typed"
        ],
        "description": "[![Build Status](https://travis-ci.org/volfpeter/markyp-fontawesome.svg?branch=master)](https://travis-ci.org/volfpeter/markyp-fontawesome)\n[![Downloads](https://pepy.tech/badge/markyp-fontawesome)](https://pepy.tech/project/markyp-fontawesome)\n[![Downloads](https://pepy.tech/badge/markyp-fontawesome/month)](https://pepy.tech/project/markyp-fontawesome/month)\n[![Downloads](https://pepy.tech/badge/markyp-fontawesome/week)](https://pepy.tech/project/markyp-fontawesome/week)\n\n# markyp-fontawesome\n\nFont Awesome 5 icons for web pages built with [markyp-html](https://github.com/volfpeter/markyp-html).\n\n## Installation\n\nThe project is listed on the Python Package Index, it can be installed simply by executing `pip install markyp-fontawesome`.\n\n## Getting started\n\n### Font Awesome setup\n\nFirst of all, you should acquire a Font Awesome kit code [here](https://fontawesome.com/start).\n\n### Creating icons for `markyp-html` webpages\n\nIf you are not familiar with the basic concepts of `markyp`, please start by having a look at its documentation [here](https://github.com/volfpeter/markyp).\n\nThe following example code shows the creation of a webpage that displays a large, spinning Python logo over a solid square.\n\n```Python\n# markyp-html webpage element\nfrom markyp_html import webpage\n\n# Font Awesome imports\nfrom markyp_fontawesome import kit_import, brand, solid, stack, IconStyle as IS\n\n# Your Font Awesome kit code.\nfa_kit_code = \"a076d05399\"\n\npage = webpage(\n    # 3x-sized Font Awesome icon stack\n    stack.x3(\n        # Solid square icon for the background\n        solid(\"square\", class_=IS.stacked_size_2x),\n        # Inverse Python brand icon for the foreground\n        brand(\"python\", class_=f\"{IS.stacked_size_2x} {IS.inverse} {IS.spin}\"),\n    ),\n    page_title=\"markyp-fontawesome demo\",\n    # Font Awesome kit import with kit code\n    javascript=[kit_import(fa_kit_code)],\n)\n\nprint(page)\n```\n\nThings to note from the example:\n\n- You need to pass the Font Awesome import element to the `javascript` keyword argument of `webpage()` to be able to display Font Awesome icons on the page.\n- `stack()` and its factory methods like `x3()` let you create Font Awesome icon stacks.\n- `brand` and `solid` (and their factory methods) let you create Font Awesome icons of Brands and Solid styles. (Pro styles are also supported.)\n- The `IconStyle` enumeration class lets you customize icons by passing its properties to the icons' `class_` argument.\n\nFor more details on how this package works, please see [markyp](https://github.com/volfpeter/markyp) and [markyp-html](https://github.com/volfpeter/markyp-html).\n\nFor more details on how to use Font Awesome 5, see [this](https://fontawesome.com/how-to-use/on-the-web/referencing-icons/basic-use) page.\n\n## Community guidelines\n\nIn general, please treat each other with respect and follow the below guidelines to interact with the project:\n\n- _Questions, feedback_: Open an issue with a `[Question] <issue-title>` title.\n- _Bug reports_: Open an issue with a `[Bug] <issue-title>` title, an adequate description of the bug, and a code snippet that reproduces the issue if possible.\n- _Feature requests and ideas_: Open an issue with an `[Enhancement] <issue-title>` title and a clear description of the enhancement proposal.\n\n## Contribution guidelines\n\nEvery form of contribution is welcome, including documentation improvements, tests, bug fixes, and feature implementations.\n\nPlease follow these guidelines to contribute to the project:\n\n- Make sure your changes match the documentation and coding style of the project, including [PEP 484](https://www.python.org/dev/peps/pep-0484/) type annotations.\n- `mypy` is used to type-check the codebase, submitted code should not produce typing errors. See [this page](http://mypy-lang.org/) for more information on `mypy`.\n- _Small_ fixes can be submitted simply by creating a pull request.\n- Non-trivial changes should have an associated [issue](#community-guidelines) in the issue tracker that commits must reference (typically by adding `#refs <issue-id>` to the end of commit messages).\n- Please write [tests](#testing) for the changes you make (if applicable).\n\nIf you have any questions about contributing to the project, please contact the project owner.\n\nAs mentioned in the [contribution guidelines](#contribution-guidelines), the project is type-checked using `mypy`, so first of all, the project must pass `mypy`'s static code analysis.\n\nThe project is tested using `pytest`. The chosen test layout is that tests are outside the application code, see [this page](https://docs.pytest.org/en/latest/goodpractices.html#tests-outside-application-code) for details on what it means in practice.\n\nIf `pytest` is installed, the test set can be executed using the `pytest test` command from within the project directory.\n\nIf `pytest-cov` is also installed, a test coverage report can be generated by executing `pytest test --cov markyp_fontawesome` from the root directory of the project.\n\n## License - MIT\n\nThe library is open-sourced under the conditions of the MIT [license](https://choosealicense.com/licenses/mit/).\n\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/volfpeter/markyp-fontawesome",
        "keywords": "fontawesome font awesome html icon markup generator utility",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "markyp-fontawesome",
        "package_url": "https://pypi.org/project/markyp-fontawesome/",
        "platform": "",
        "project_url": "https://pypi.org/project/markyp-fontawesome/",
        "project_urls": {
            "Homepage": "https://github.com/volfpeter/markyp-fontawesome"
        },
        "release_url": "https://pypi.org/project/markyp-fontawesome/0.1910.0/",
        "requires_dist": [
            "markyp-html (>=0.1910)",
            "markyp (>=0.1910)"
        ],
        "requires_python": ">=3.7",
        "summary": "Font Awesome icons for markyp-html webpages.",
        "version": "0.1910.0",
        "yanked": false,
        "yanked_reason": null
    },
    "last_serial": 6009136,
    "releases": {
        "0.1910.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5067624bad16a3d287bbc1574e227457",
                    "sha256": "d4d7b9100ee8cb39a8bdd227c84d85922a27e6c7d84a401bccbbd623b25171c8"
                },
                "downloads": -1,
                "filename": "markyp_fontawesome-0.1910.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "5067624bad16a3d287bbc1574e227457",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.7",
                "size": 6808,
                "upload_time": "2019-10-21T20:17:10",
                "upload_time_iso_8601": "2019-10-21T20:17:10.284484Z",
                "url": "https://files.pythonhosted.org/packages/6a/7c/a130891120837fa7a19fbb9f3789444a6b482ecf1f1e29f8dee9644574de/markyp_fontawesome-0.1910.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a4f1e9e1a4e64c86750deccbdcd6d906",
                    "sha256": "42e6c30cabf5c3a4240970af64b3eb6ff1d2a3e048c5f19bc9a998b8a3c0da98"
                },
                "downloads": -1,
                "filename": "markyp-fontawesome-0.1910.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a4f1e9e1a4e64c86750deccbdcd6d906",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.7",
                "size": 6867,
                "upload_time": "2019-10-21T20:17:13",
                "upload_time_iso_8601": "2019-10-21T20:17:13.532331Z",
                "url": "https://files.pythonhosted.org/packages/da/44/011c657ae0f2ef1302bdc609dd8fe827a089b5b1ebd3b03b05219cb9806e/markyp-fontawesome-0.1910.0.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5067624bad16a3d287bbc1574e227457",
                "sha256": "d4d7b9100ee8cb39a8bdd227c84d85922a27e6c7d84a401bccbbd623b25171c8"
            },
            "downloads": -1,
            "filename": "markyp_fontawesome-0.1910.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5067624bad16a3d287bbc1574e227457",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 6808,
            "upload_time": "2019-10-21T20:17:10",
            "upload_time_iso_8601": "2019-10-21T20:17:10.284484Z",
            "url": "https://files.pythonhosted.org/packages/6a/7c/a130891120837fa7a19fbb9f3789444a6b482ecf1f1e29f8dee9644574de/markyp_fontawesome-0.1910.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a4f1e9e1a4e64c86750deccbdcd6d906",
                "sha256": "42e6c30cabf5c3a4240970af64b3eb6ff1d2a3e048c5f19bc9a998b8a3c0da98"
            },
            "downloads": -1,
            "filename": "markyp-fontawesome-0.1910.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a4f1e9e1a4e64c86750deccbdcd6d906",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6867,
            "upload_time": "2019-10-21T20:17:13",
            "upload_time_iso_8601": "2019-10-21T20:17:13.532331Z",
            "url": "https://files.pythonhosted.org/packages/da/44/011c657ae0f2ef1302bdc609dd8fe827a089b5b1ebd3b03b05219cb9806e/markyp-fontawesome-0.1910.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "vulnerabilities": []
}