| Name | pylabnotebook JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | This package provides functions to write an automated labnotebook using git. |
| upload_time | 2024-09-11 15:54:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
git
notebook
track
history
log
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">Labnotebook 📔🖥</h1>
This project aims to help bioinformaticians in creating the so called "Laboratory notebook" automatically, thanks to git workflow manager.
Read the [documentation](https://pylabnotebook.readthedocs.io/en/latest/user_guide.html).
**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.
<h3 style="margin-bottom:3px;">Features</h3>
<ul>
<li>Automatically create a laboratory notebook</li>
<li>Customizable CSS file</li>
<li>Direct link to analysis files (expecially for user who creates .html reports. e.g. markdown or jupyter notebook html)</li>
<li>Export to html</li>
</ul>
<h3>Installation</h3>
To install the package, run:
```
pip install pylabnotebook
```
This will install the pylabnotebook package; you can then run <code>labnotebook</code> function from within the terminal (detailed explanation below).
<h3>Notebook structure</h3>
The structure of the notebook is very simple. You can see an example <a href='https://miotsdata.netlify.app/it/bash/mie_funzioni/example.html' target='_blank'>here</a>.
<p style="margin-bottom:0px;">On top, you have the notebook name, the author and the notebook creation date. Then, for each day, you have a list of all the commits done, organized as follow:</p>
<ul>
<li>Commit message (first line)</li>
<li>Commit body</li>
<li>Commit author</li>
<li>Commit sha</li>
<li>Analysis file (which can be hidden if you don't have this type of features)</li>
<li>List of changed files</li>
</ul>
<h3>Create a notebook</h3>
To create a notebook, go to the folder in which is present the .git folder and type <code>labnotebook create -n <name_of_the_notebook></code>. If you want to have spaces in your name, just wrap it into quotes.
A .labnotebook folder is created, containing config.json file, a basic .css file and three file containing head, body and footer html file.
**IMPORTANT**: never change the name of the created folder and its files!
<h3>Update a notebook</h3>
When you want to update the notebook, go to the folder in which is present the .git folder, type <code>labnotebook update</code>. It will check for new commits and upate the files in .labnotebook folder.
<br>
If the git history have changed and the last commit present in the labnotebook is no longer in git history, it will raise an error; you can skip this by forcing the update (<code>-f/--force</code>).
**IMPORTANT**: After each notebook update a commit is made with labnotebook as author. This will ensure that these commits are not considered during the update, as only commits without labnotebook as author are used.
<h4>Link to analysis files</h4>
When updating the notebook, it automatically create a list of analysis files for each commit with direct links to them. By default, it takes all the .html files changed/added in that commit.<br>
If you want to add different extensions, you can update the .labnotebook config.json file by adding/removing extensions in the ANALYSIS_EXT variable. Each extension should be separated by a comma, as it is considered an array (eg. "ANALYSIS_EXT": ['.html', '.txt'])Just type the extension, not wildcards or other special characters.<br>
Moreover, by creating a ".labignore" file, you can exclude some files/folders to be recognized as analysis files (as for a standard .gitignore file it will use wildcards).
<h3>Export html file</h3>
When you want to export the full html file containing the notebook, go to the folder in which is present the .git folder, type <code>labnotebook export -o <name_of_the_output_file></code>.
<h3>Issue reporting and suggestions</h3>
If you find any issue or you want to suggest some edit, please feel free to open an issue or a pull request.
Raw data
{
"_id": null,
"home_page": null,
"name": "pylabnotebook",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "git, notebook, track, history, log",
"author": null,
"author_email": "Matteo Miotto <miotsdata@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/b5/e4/4202c98341433f34d95fbd8ac01a4ff35a78957d626b03b87f0cc7f4448e/pylabnotebook-0.2.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">Labnotebook \ud83d\udcd4\ud83d\udda5</h1>\n\nThis project aims to help bioinformaticians in creating the so called \"Laboratory notebook\" automatically, thanks to git workflow manager.\nRead the [documentation](https://pylabnotebook.readthedocs.io/en/latest/user_guide.html).\n\n**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.\n\n<h3 style=\"margin-bottom:3px;\">Features</h3>\n<ul>\n <li>Automatically create a laboratory notebook</li>\n <li>Customizable CSS file</li>\n <li>Direct link to analysis files (expecially for user who creates .html reports. e.g. markdown or jupyter notebook html)</li>\n <li>Export to html</li>\n</ul>\n\n<h3>Installation</h3>\nTo install the package, run:\n\n```\npip install pylabnotebook\n```\n\nThis will install the pylabnotebook package; you can then run <code>labnotebook</code> function from within the terminal (detailed explanation below).\n\n<h3>Notebook structure</h3>\nThe structure of the notebook is very simple. You can see an example <a href='https://miotsdata.netlify.app/it/bash/mie_funzioni/example.html' target='_blank'>here</a>.\n\n<p style=\"margin-bottom:0px;\">On top, you have the notebook name, the author and the notebook creation date. Then, for each day, you have a list of all the commits done, organized as follow:</p>\n<ul>\n <li>Commit message (first line)</li>\n <li>Commit body</li>\n <li>Commit author</li>\n <li>Commit sha</li>\n <li>Analysis file (which can be hidden if you don't have this type of features)</li>\n <li>List of changed files</li>\n</ul>\n\n<h3>Create a notebook</h3>\nTo create a notebook, go to the folder in which is present the .git folder and type <code>labnotebook create -n <name_of_the_notebook></code>. If you want to have spaces in your name, just wrap it into quotes.\n\nA .labnotebook folder is created, containing config.json file, a basic .css file and three file containing head, body and footer html file.\n\n**IMPORTANT**: never change the name of the created folder and its files!\n\n<h3>Update a notebook</h3>\nWhen you want to update the notebook, go to the folder in which is present the .git folder, type <code>labnotebook update</code>. It will check for new commits and upate the files in .labnotebook folder.\n<br>\nIf the git history have changed and the last commit present in the labnotebook is no longer in git history, it will raise an error; you can skip this by forcing the update (<code>-f/--force</code>).\n\n**IMPORTANT**: After each notebook update a commit is made with labnotebook as author. This will ensure that these commits are not considered during the update, as only commits without labnotebook as author are used.\n\n<h4>Link to analysis files</h4>\nWhen updating the notebook, it automatically create a list of analysis files for each commit with direct links to them. By default, it takes all the .html files changed/added in that commit.<br>\nIf you want to add different extensions, you can update the .labnotebook config.json file by adding/removing extensions in the ANALYSIS_EXT variable. Each extension should be separated by a comma, as it is considered an array (eg. \"ANALYSIS_EXT\": ['.html', '.txt'])Just type the extension, not wildcards or other special characters.<br>\nMoreover, by creating a \".labignore\" file, you can exclude some files/folders to be recognized as analysis files (as for a standard .gitignore file it will use wildcards).\n\n<h3>Export html file</h3>\nWhen you want to export the full html file containing the notebook, go to the folder in which is present the .git folder, type <code>labnotebook export -o <name_of_the_output_file></code>.\n\n<h3>Issue reporting and suggestions</h3>\nIf you find any issue or you want to suggest some edit, please feel free to open an issue or a pull request.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "This package provides functions to write an automated labnotebook using git.",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/mmiots9/pylabnotebook",
"Issues": "https://github.com/mmiots9/pylabnotebook/issues"
},
"split_keywords": [
"git",
" notebook",
" track",
" history",
" log"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "920843b4da7bb29e491e31f03da93b9ec1b9587c9ef08cdeada8d2174275842c",
"md5": "237f4bda095129cf7d6986ca699db8ec",
"sha256": "455feb7880ac72eb7f29a8aea718f833df5304d42f85943467f033efb3c82efd"
},
"downloads": -1,
"filename": "pylabnotebook-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "237f4bda095129cf7d6986ca699db8ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 12386,
"upload_time": "2024-09-11T15:54:19",
"upload_time_iso_8601": "2024-09-11T15:54:19.567953Z",
"url": "https://files.pythonhosted.org/packages/92/08/43b4da7bb29e491e31f03da93b9ec1b9587c9ef08cdeada8d2174275842c/pylabnotebook-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5e44202c98341433f34d95fbd8ac01a4ff35a78957d626b03b87f0cc7f4448e",
"md5": "f080540d530d39bd8efc22ef1f5f7fa8",
"sha256": "87eb7728354287a82c837c1a7157e627317d2d84840f05fdd70639d5bc849efd"
},
"downloads": -1,
"filename": "pylabnotebook-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "f080540d530d39bd8efc22ef1f5f7fa8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12216,
"upload_time": "2024-09-11T15:54:21",
"upload_time_iso_8601": "2024-09-11T15:54:21.019471Z",
"url": "https://files.pythonhosted.org/packages/b5/e4/4202c98341433f34d95fbd8ac01a4ff35a78957d626b03b87f0cc7f4448e/pylabnotebook-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 15:54:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mmiots9",
"github_project": "pylabnotebook",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pylabnotebook"
}
