ichandbook

Name	ichandbook JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	Library to help formating and publication of organisation technical handbook.
upload_time	2024-04-12 08:37:52
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords	publishing markdown handbook
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # ichandbook

This project is a set of tools to support publication and maintenance of the [ICHEC technical handbook](https://git.ichec.ie/performance/ichec-handbook). It may be useful for maintaining other technical projects too.

# Running Tests

In a Python virtual environment do:

```sh
pip install .'[test]'
```

## Unit Tests

```sh
pytest
```

## Linting and Static Analysis

```sh
black src test
mypy src test
```

## All Tests

Requires `tox`:

```sh
tox
```



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ichandbook",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "Publishing, Markdown, Handbook",
    "author": null,
    "author_email": "\"James Grogan, Irish Centre for High End Computing\" <james.grogan@ichec.ie>",
    "download_url": "https://files.pythonhosted.org/packages/a0/71/a86f7027c35dc43205253844053b223e483fe48079c79b1fcd33392271c6/ichandbook-0.0.1.tar.gz",
    "platform": null,
    "description": "# ichandbook\n\nThis project is a set of tools to support publication and maintenance of the [ICHEC technical handbook](https://git.ichec.ie/performance/ichec-handbook). It may be useful for maintaining other technical projects too.\n\n# Running Tests\n\nIn a Python virtual environment do:\n\n```sh\npip install .'[test]'\n```\n\n## Unit Tests\n\n```sh\npytest\n```\n\n## Linting and Static Analysis\n\n```sh\nblack src test\nmypy src test\n```\n\n## All Tests\n\nRequires `tox`:\n\n```sh\ntox\n```\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Library to help formating and publication of organisation technical handbook.",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://git.ichec.ie/performance/toolshed/ichandbook",
        "Repository": "https://git.ichec.ie/performance/toolshed/ichandbook"
    },
    "split_keywords": [
        "publishing",
        " markdown",
        " handbook"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96f3e0f1c058b45db483b675d1f2e6902b5461b9d6cb7bf0d655e21d05f52ba3",
                "md5": "d015dc787a55e42eafbec78b4de70ed6",
                "sha256": "9ad27d9c88d13879a863fbbbf38187da6d95b328088b32ed17fc7f6fc344ce11"
            },
            "downloads": -1,
            "filename": "ichandbook-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d015dc787a55e42eafbec78b4de70ed6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 15577,
            "upload_time": "2024-04-12T08:37:50",
            "upload_time_iso_8601": "2024-04-12T08:37:50.203409Z",
            "url": "https://files.pythonhosted.org/packages/96/f3/e0f1c058b45db483b675d1f2e6902b5461b9d6cb7bf0d655e21d05f52ba3/ichandbook-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a071a86f7027c35dc43205253844053b223e483fe48079c79b1fcd33392271c6",
                "md5": "6b2f5e0b033bc2fdf52553afc0a65197",
                "sha256": "ecfd0bef060ea896fd0c3a5d28c53554632690d6e1a2abf711aedf26d05d2f55"
            },
            "downloads": -1,
            "filename": "ichandbook-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6b2f5e0b033bc2fdf52553afc0a65197",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 15514,
            "upload_time": "2024-04-12T08:37:52",
            "upload_time_iso_8601": "2024-04-12T08:37:52.253134Z",
            "url": "https://files.pythonhosted.org/packages/a0/71/a86f7027c35dc43205253844053b223e483fe48079c79b1fcd33392271c6/ichandbook-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-12 08:37:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ichandbook"
}