Metadata-Version: 2.1
Name: logbookgenerator
Version: 1.0.11
Summary: Generates a logbook. Designed for the University of Lincoln's Scientific Computing module.
Home-page: https://github.com/unkokaeru/logbookgenerator
License: MIT
Author: William Fayers
Author-email: william@fayers.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: jinja2 (>=3.1.4,<4.0.0)
Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
Requires-Dist: questionary (>=2.0.1,<3.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Project-URL: Repository, https://github.com/unkokaeru/logbookgenerator
Description-Content-Type: text/markdown

# 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.
