logbookgenerator


Namelogbookgenerator JSON
Version 1.0.15 PyPI version JSON
download
home_pagehttps://github.com/unkokaeru/logbookgenerator
SummaryGenerates a logbook. Designed for the University of Lincoln's Scientific Computing module.
upload_time2024-11-10 19:15:28
maintainerNone
docs_urlNone
authorWilliam Fayers
requires_python<4.0,>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements jinja2 markdown-it-py markupsafe mdurl prompt-toolkit pygments pyyaml questionary rich typing-extensions wcwidth
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # logbookgenerator

[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/unkokaeru/logbookgenerator?label=version)](https://github.com/unkokaeru/logbookgenerator)
[![Lines Of Code](https://tokei.rs/b1/github/unkokaeru/logbookgenerator?category=code)](https://github.com/unkokaeru/logbookgenerator)
[![Continuous Integration (CI) Tests](https://img.shields.io/github/actions/workflow/status/unkokaeru/logbookgenerator/continuous_integration.yml?label=tests)](https://github.com/unkokaeru/logbookgenerator)
[![GitHub last commit](https://img.shields.io/github/last-commit/unkokaeru/logbookgenerator)](https://github.com/unkokaeru/logbookgenerator)

Generates a logbook. Designed for the University of Lincoln's Scientific Computing module.

- [logbookgenerator](#logbookgenerator)
    - [Features](#features)
    - [Installation](#installation)
    - [Usage](#usage)
    - [Documentation](#documentation)
    - [Contributing](#contributing)
    - [License](#license)

## Features

- [x] Installable via pip
- [x] Command-line interface
- [x] Interactive documentation
- [ ] Dynamically generate logbooks

## Installation

To install logbookgenerator, simply run:

```bash
pip install logbookgenerator
```

## Usage

After installation, you can use logbookgenerator by running:

```bash
$ python3 -m logbookgenerator
# or
$ logbookgenerator
```

## Documentation
For more information, you can find the documentation within the [docs](./docs/index.html) directory or on the project's [GitHub Pages](https://unkokaeru.github.io/logbookgenerator/).

## Contributing

Contributions are welcome! Please refer to our [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/unkokaeru/logbookgenerator",
    "name": "logbookgenerator",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "William Fayers",
    "author_email": "william@fayers.com",
    "download_url": "https://files.pythonhosted.org/packages/06/02/b83611879996d959ac5ab5b1e2731c7bf20bf6b7a7e0d7a89b141611bf86/logbookgenerator-1.0.15.tar.gz",
    "platform": null,
    "description": "# logbookgenerator\n\n[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/unkokaeru/logbookgenerator?label=version)](https://github.com/unkokaeru/logbookgenerator)\n[![Lines Of Code](https://tokei.rs/b1/github/unkokaeru/logbookgenerator?category=code)](https://github.com/unkokaeru/logbookgenerator)\n[![Continuous Integration (CI) Tests](https://img.shields.io/github/actions/workflow/status/unkokaeru/logbookgenerator/continuous_integration.yml?label=tests)](https://github.com/unkokaeru/logbookgenerator)\n[![GitHub last commit](https://img.shields.io/github/last-commit/unkokaeru/logbookgenerator)](https://github.com/unkokaeru/logbookgenerator)\n\nGenerates a logbook. Designed for the University of Lincoln's Scientific Computing module.\n\n- [logbookgenerator](#logbookgenerator)\n    - [Features](#features)\n    - [Installation](#installation)\n    - [Usage](#usage)\n    - [Documentation](#documentation)\n    - [Contributing](#contributing)\n    - [License](#license)\n\n## Features\n\n- [x] Installable via pip\n- [x] Command-line interface\n- [x] Interactive documentation\n- [ ] Dynamically generate logbooks\n\n## Installation\n\nTo install logbookgenerator, simply run:\n\n```bash\npip install logbookgenerator\n```\n\n## Usage\n\nAfter installation, you can use logbookgenerator by running:\n\n```bash\n$ python3 -m logbookgenerator\n# or\n$ logbookgenerator\n```\n\n## Documentation\nFor more information, you can find the documentation within the [docs](./docs/index.html) directory or on the project's [GitHub Pages](https://unkokaeru.github.io/logbookgenerator/).\n\n## Contributing\n\nContributions are welcome! Please refer to our [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Generates a logbook. Designed for the University of Lincoln's Scientific Computing module.",
    "version": "1.0.15",
    "project_urls": {
        "Homepage": "https://github.com/unkokaeru/logbookgenerator",
        "Repository": "https://github.com/unkokaeru/logbookgenerator"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d36ebba0fa286445a6c362700cc09da073b76682ab2d78c6bcd05ed5fd74aa93",
                "md5": "043f79a2f7d1028c057c23b6dabd1ec3",
                "sha256": "d7f50070be60fb95732b9fccf687b17220cea0360b70f5941daddc5842719e33"
            },
            "downloads": -1,
            "filename": "logbookgenerator-1.0.15-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "043f79a2f7d1028c057c23b6dabd1ec3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 24490,
            "upload_time": "2024-11-10T19:15:27",
            "upload_time_iso_8601": "2024-11-10T19:15:27.598758Z",
            "url": "https://files.pythonhosted.org/packages/d3/6e/bba0fa286445a6c362700cc09da073b76682ab2d78c6bcd05ed5fd74aa93/logbookgenerator-1.0.15-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0602b83611879996d959ac5ab5b1e2731c7bf20bf6b7a7e0d7a89b141611bf86",
                "md5": "b0e446cc51097669a42256180e73f246",
                "sha256": "4c5fa6867a1d37dca91fef5948fb223e0555b5a2bc176996a9cb9702f69c22a8"
            },
            "downloads": -1,
            "filename": "logbookgenerator-1.0.15.tar.gz",
            "has_sig": false,
            "md5_digest": "b0e446cc51097669a42256180e73f246",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 16508,
            "upload_time": "2024-11-10T19:15:28",
            "upload_time_iso_8601": "2024-11-10T19:15:28.614905Z",
            "url": "https://files.pythonhosted.org/packages/06/02/b83611879996d959ac5ab5b1e2731c7bf20bf6b7a7e0d7a89b141611bf86/logbookgenerator-1.0.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-10 19:15:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "unkokaeru",
    "github_project": "logbookgenerator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "jinja2",
            "specs": [
                [
                    "==",
                    "3.1.4"
                ]
            ]
        },
        {
            "name": "markdown-it-py",
            "specs": [
                [
                    "==",
                    "3.0.0"
                ]
            ]
        },
        {
            "name": "markupsafe",
            "specs": [
                [
                    "==",
                    "3.0.2"
                ]
            ]
        },
        {
            "name": "mdurl",
            "specs": [
                [
                    "==",
                    "0.1.2"
                ]
            ]
        },
        {
            "name": "prompt-toolkit",
            "specs": [
                [
                    "==",
                    "3.0.36"
                ]
            ]
        },
        {
            "name": "pygments",
            "specs": [
                [
                    "==",
                    "2.18.0"
                ]
            ]
        },
        {
            "name": "pyyaml",
            "specs": [
                [
                    "==",
                    "6.0.2"
                ]
            ]
        },
        {
            "name": "questionary",
            "specs": [
                [
                    "==",
                    "2.0.1"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    "==",
                    "13.9.4"
                ]
            ]
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "==",
                    "4.12.2"
                ]
            ]
        },
        {
            "name": "wcwidth",
            "specs": [
                [
                    "==",
                    "0.2.13"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "logbookgenerator"
}
        
Elapsed time: 1.82348s