semvec/pypi-packages huggingface dataset:
logbookgenerator 1.0.15
Generates a logbook. Designed for the University of Lincoln's Scientific Computing module.
License: MIT
Requires Python: <4.0,>=3.10

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