frigate


Namefrigate JSON
Version 0.7.0 PyPI version JSON
download
home_page
SummaryA tool for autogenerating helm documentation.
upload_time2023-03-31 16:19:17
maintainer
docs_urlNone
authorJacob Tomlinson
requires_python
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Frigate

Frigate is a tool for automatically generating documentation for your [Helm charts](https://helm.sh/).

<!-- TODO: Add badges for CI, PyPI, etc -->

Features:

- Render documentation from your `Chart.yaml` and `values.yaml` files.
- Supports outputting as markdown, reStructuredText and HTML.
- Sphinx extension for including in Python documentation.

## Installation

```
$ pip install frigate
```

## Usage

```
$ frigate gen path/to/chart

Chart
==========

Chart description.

...
```

<!-- TODO: Link to docs once set up on RTD -->



### Pre-commit-hook

Into the repository you want to have the pre-commit hook installed, run:


```
cat <<EOF >> .pre-commit-config.yaml
- repo: https://github.com/rapidsai/frigate
  rev: v0.4.0 #  pre-commit autoupdate  - to keep the version up to date
  hooks:
    - id: frigate
EOF
```


#### Parameters

You can add extra parameters with :


```
- repo: https://github.com/rapidsai/frigate
  rev: v0.4.0 #  pre-commit autoupdate  - to keep the version up to date
  hooks:
    - id: frigate
      args:
        - --output=README.rst
        - --format=rst
        - --no-credits
        - --no-deps

```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "frigate",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jacob Tomlinson",
    "author_email": "jtomlinson@nvidia.com",
    "download_url": "https://files.pythonhosted.org/packages/88/77/584bb28ba1e1296a26157d78e76d1407bf1bd3853587248124fe60e233d1/frigate-0.7.0.tar.gz",
    "platform": "any",
    "description": "# Frigate\n\nFrigate is a tool for automatically generating documentation for your [Helm charts](https://helm.sh/).\n\n<!-- TODO: Add badges for CI, PyPI, etc -->\n\nFeatures:\n\n- Render documentation from your `Chart.yaml` and `values.yaml` files.\n- Supports outputting as markdown, reStructuredText and HTML.\n- Sphinx extension for including in Python documentation.\n\n## Installation\n\n```\n$ pip install frigate\n```\n\n## Usage\n\n```\n$ frigate gen path/to/chart\n\nChart\n==========\n\nChart description.\n\n...\n```\n\n<!-- TODO: Link to docs once set up on RTD -->\n\n\n\n### Pre-commit-hook\n\nInto the repository you want to have the pre-commit hook installed, run:\n\n\n```\ncat <<EOF >> .pre-commit-config.yaml\n- repo: https://github.com/rapidsai/frigate\n  rev: v0.4.0 #  pre-commit autoupdate  - to keep the version up to date\n  hooks:\n    - id: frigate\nEOF\n```\n\n\n#### Parameters\n\nYou can add extra parameters with :\n\n\n```\n- repo: https://github.com/rapidsai/frigate\n  rev: v0.4.0 #  pre-commit autoupdate  - to keep the version up to date\n  hooks:\n    - id: frigate\n      args:\n        - --output=README.rst\n        - --format=rst\n        - --no-credits\n        - --no-deps\n\n```\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "A tool for autogenerating helm documentation.",
    "version": "0.7.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5b056e78e1621d355ce8375e0caecccba04ef1392f4cc40946da6d6dcf00a5b8",
                "md5": "f7ea378c261cf130fa9b5c0a8f1bd49f",
                "sha256": "0054f717e11f21f19a62883389da759e0f16ef59fa1905fda95d679044472277"
            },
            "downloads": -1,
            "filename": "frigate-0.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f7ea378c261cf130fa9b5c0a8f1bd49f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 11337,
            "upload_time": "2023-03-31T16:19:15",
            "upload_time_iso_8601": "2023-03-31T16:19:15.556049Z",
            "url": "https://files.pythonhosted.org/packages/5b/05/6e78e1621d355ce8375e0caecccba04ef1392f4cc40946da6d6dcf00a5b8/frigate-0.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8877584bb28ba1e1296a26157d78e76d1407bf1bd3853587248124fe60e233d1",
                "md5": "c92be33991300a0d0c9594248fdf653c",
                "sha256": "6751aa48945b5dc5d6a415a6e02dfa5c6fa67799dffcc377a1cda4e317d231c2"
            },
            "downloads": -1,
            "filename": "frigate-0.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c92be33991300a0d0c9594248fdf653c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 25190,
            "upload_time": "2023-03-31T16:19:17",
            "upload_time_iso_8601": "2023-03-31T16:19:17.018024Z",
            "url": "https://files.pythonhosted.org/packages/88/77/584bb28ba1e1296a26157d78e76d1407bf1bd3853587248124fe60e233d1/frigate-0.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-31 16:19:17",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "frigate"
}
        
Elapsed time: 0.86552s