fretty-book


Namefretty-book JSON
Version 0.1 PyPI version JSON
download
home_pagehttps://github.com/thomasvolk/fretty-book
Summaryfretty-book can replace inline fretty markup within documents with the generated images
upload_time2024-02-12 19:23:50
maintainer
docs_urlNone
authorThomas Volk
requires_python>=3.9.0
licenseApache
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # fretty-book

fretty-book can replace inline [fretty](https://github.com/thomasvolk/fretty) markup within documents with the generated images.

## Installation

    pip install fretty-book

## Usage

    fretty-book example/simple.html -o simple.html


## Markup

fretty-book can process HTML and XHTML documents. All `<fretty>` tags will be replaced with the image generated with the included markup. 

### html

This markup ...

```
<!DOCTYPE html>
<html>
    <head>
        <title>test document</title>
    </head>
    <body>

        <h3>Fretty test document for html processing</h3>

        <p>Tabs for C major scale</p>
        <fretty width="400">
            III
            --o-o1
            --oo-o
            -o1-o-
            o-o-o-
            1-o-o-
            o-o-o-
        </fretty>
    </body>
</html>
```
will produce this result:

---

<h3>Fretty test document for html processing</h3>

<p>Tabs for C major scale</p>

<img src="https://raw.githubusercontent.com/thomasvolk/fretty-book/master/example/simple/fretty-0.svg"/>

---

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/thomasvolk/fretty-book",
    "name": "fretty-book",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Thomas Volk",
    "author_email": "info@thomasvolk.de",
    "download_url": "",
    "platform": "any",
    "description": "# fretty-book\n\nfretty-book can replace inline [fretty](https://github.com/thomasvolk/fretty) markup within documents with the generated images.\n\n## Installation\n\n    pip install fretty-book\n\n## Usage\n\n    fretty-book example/simple.html -o simple.html\n\n\n## Markup\n\nfretty-book can process HTML and XHTML documents. All `<fretty>` tags will be replaced with the image generated with the included markup. \n\n### html\n\nThis markup ...\n\n```\n<!DOCTYPE html>\n<html>\n    <head>\n        <title>test document</title>\n    </head>\n    <body>\n\n        <h3>Fretty test document for html processing</h3>\n\n        <p>Tabs for C major scale</p>\n        <fretty width=\"400\">\n            III\n            --o-o1\n            --oo-o\n            -o1-o-\n            o-o-o-\n            1-o-o-\n            o-o-o-\n        </fretty>\n    </body>\n</html>\n```\nwill produce this result:\n\n---\n\n<h3>Fretty test document for html processing</h3>\n\n<p>Tabs for C major scale</p>\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty-book/master/example/simple/fretty-0.svg\"/>\n\n---\n",
    "bugtrack_url": null,
    "license": "Apache",
    "summary": "fretty-book can replace inline fretty markup within documents with the generated images",
    "version": "0.1",
    "project_urls": {
        "Homepage": "https://github.com/thomasvolk/fretty-book"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3081bf0778ff341ef9db79697b39734f788d3bacee96fbd7edfec64bb7d8ed22",
                "md5": "caece86533c2262cdb7fca919a0af103",
                "sha256": "a367a7d67fc58bc7461b20e71cf269a326fe6cfac076a3e87e57316769963042"
            },
            "downloads": -1,
            "filename": "fretty_book-0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "caece86533c2262cdb7fca919a0af103",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.0",
            "size": 8044,
            "upload_time": "2024-02-12T19:23:50",
            "upload_time_iso_8601": "2024-02-12T19:23:50.942546Z",
            "url": "https://files.pythonhosted.org/packages/30/81/bf0778ff341ef9db79697b39734f788d3bacee96fbd7edfec64bb7d8ed22/fretty_book-0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-12 19:23:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "thomasvolk",
    "github_project": "fretty-book",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fretty-book"
}
        
Elapsed time: 0.22694s