Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.2 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.2 KB

Labnotebook 📔🖥

This project aims to help bioinformaticians in creating the so called "Laboratory notebook" automatically, thanks to git workflow manager. Read the documentation.

IMPORTANT: this tool is based on git and its application, in particular, through git history it will create an html notebook divided by date and commit.

Features

  • Automatically create a laboratory notebook
  • Customizable CSS file
  • Direct link to analysis files (expecially for user who creates .html reports. e.g. markdown or jupyter notebook html)
  • Export to html

Installation

To install the package, run:
pip install pylabnotebook

This will install the pylabnotebook package; you can then run labnotebook function from within the terminal (detailed explanation below).

For a complete guide, check the official user guide.

Issue reporting and suggestions

If you find any issue or you want to suggest some edit, please feel free to open an issue or a pull request.