icreports

Name	icreports JSON
Version	0.0.8 JSON
	download
home_page	None
Summary	Utilities for generating technical reports.
upload_time	2024-07-26 08:17:32
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords	publishing technical reports
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # icreports

This project is a collection of tools and templates for generating reports at IHCEC.

# Contents #

## Latex Templates ##

### Technical Report ###

There is a sample Technical Report template in `meida/templates/latex/technical_report.tex`, which can be converted to a PDF with `pdflatex`.

### Gantt Chart ###

There is a sample Gantt Chart template in `media/templates/latex/gantt.tex`. It needs a few LaTeX packages for use:

``` shell
tlmgr install pgfgantt standalone helvetic
```

Then it can be used to generate a PDF with `pdflatex`.

## Python Module ##

The `icreports` Python module is used to generated the ICHEC handbook. It is a wrapper over JupyterBook, with extra features to allow separate public and internal builds and dynamic generation of images defined in text formats (e.g. tikz).

You can install it with:

``` shell
pip install icreports
```

# Copyright #

Copyright 2024 Irish Centre for High End Computing

The software in this repository can be used under the conditions of the GPLv3+ license, which is available for reading in the accompanying LICENSE.txt file.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "icreports",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "Publishing, Technical Reports",
    "author": null,
    "author_email": "\"James Grogan, Irish Centre for High End Computing\" <james.grogan@ichec.ie>",
    "download_url": "https://files.pythonhosted.org/packages/b2/23/40b9b0456a31a465a66d1118aebc8564a988bccdb52d7a67df38eda558fe/icreports-0.0.8.tar.gz",
    "platform": null,
    "description": "# icreports\n\nThis project is a collection of tools and templates for generating reports at IHCEC.\n\n# Contents #\n\n## Latex Templates ##\n\n### Technical Report ###\n\nThere is a sample Technical Report template in `meida/templates/latex/technical_report.tex`, which can be converted to a PDF with `pdflatex`.\n\n### Gantt Chart ###\n\nThere is a sample Gantt Chart template in `media/templates/latex/gantt.tex`. It needs a few LaTeX packages for use:\n\n``` shell\ntlmgr install pgfgantt standalone helvetic\n```\n\nThen it can be used to generate a PDF with `pdflatex`.\n\n## Python Module ##\n\nThe `icreports` Python module is used to generated the ICHEC handbook. It is a wrapper over JupyterBook, with extra features to allow separate public and internal builds and dynamic generation of images defined in text formats (e.g. tikz).\n\nYou can install it with:\n\n``` shell\npip install icreports\n```\n\n# Copyright #\n\nCopyright 2024 Irish Centre for High End Computing\n\nThe software in this repository can be used under the conditions of the GPLv3+ license, which is available for reading in the accompanying LICENSE.txt file.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Utilities for generating technical reports.",
    "version": "0.0.8",
    "project_urls": {
        "Homepage": "https://git.ichec.ie/performance/toolshed/icreports",
        "Repository": "https://git.ichec.ie/performance/toolshed/icreports"
    },
    "split_keywords": [
        "publishing",
        " technical reports"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d62e4b95650d95f16fa9312471a0528df7c0b75b735fa39df9babc252099b614",
                "md5": "c90c34421837341a51712de4cdfb3a37",
                "sha256": "20ff1448acae0cf2f1048903d99e48365cf5e55773d4aad8e303560fa00c79eb"
            },
            "downloads": -1,
            "filename": "icreports-0.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c90c34421837341a51712de4cdfb3a37",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 21575,
            "upload_time": "2024-07-26T08:17:28",
            "upload_time_iso_8601": "2024-07-26T08:17:28.121958Z",
            "url": "https://files.pythonhosted.org/packages/d6/2e/4b95650d95f16fa9312471a0528df7c0b75b735fa39df9babc252099b614/icreports-0.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b22340b9b0456a31a465a66d1118aebc8564a988bccdb52d7a67df38eda558fe",
                "md5": "4459dfbe71523e92efb26ecebdb54334",
                "sha256": "ace400a9db811667d9cffd8af6054de69a6e0d4658b54aa4f6b5859da8ed1cd8"
            },
            "downloads": -1,
            "filename": "icreports-0.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "4459dfbe71523e92efb26ecebdb54334",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 20697,
            "upload_time": "2024-07-26T08:17:32",
            "upload_time_iso_8601": "2024-07-26T08:17:32.038672Z",
            "url": "https://files.pythonhosted.org/packages/b2/23/40b9b0456a31a465a66d1118aebc8564a988bccdb52d7a67df38eda558fe/icreports-0.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-26 08:17:32",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "icreports"
}