Metadata-Version: 2.1
Name: fresfolio
Version: 0.2.7
Summary: Flask and Vue3 based notebook for personal and research projects.
Home-page: https://github.com/dkioroglou/fresfolio/tree/main
Author: Dimitrios Kioroglou
Author-email: <d.kioroglou@hotmail.com>
License: GPL-3.0
Keywords: flask,notebook,research,reporting
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Flask>=2.0.2; python_version >= "3.8"
Requires-Dist: bcrypt==4.2.0; python_version >= "3.8"
Requires-Dist: flask-login; python_version >= "3.8"
Requires-Dist: flask-bcrypt; python_version >= "3.8"


<p align="center">
  <br>
  <img width="800" src="./docs/images/fresfolio_overview.png" alt="logo of fresfolio repository">
  <br>
  <br>
</p>

##  fresfolio [![Documentation Status](https://readthedocs.org/projects/pip/badge/?version=stable)](https://pip.pypa.io/en/stable/?badge=stable) [![Downloads](https://static.pepy.tech/badge/fresfolio)](https://pepy.tech/project/fresfolio)

*fresfolio* stands for "**F**or **Res**earch **Folio**". It is a browser-based note-taking app designed to help researchers organize and track their projects, datasets, analyses, and results in a structured format. Although the name emphasizes “research", *fresfolio* is equally suitable for personal use, allowing individuals to manage hobby and student projects, or any collection of work in an organized and interactive way. It provides tools for creating rich documentation making it easier to share findings with collaborators.

The rationale behind *fresfolio* is the following:

* User creates **Projects**.
* Each project has one or more **Notebooks**.
* Each notebook has one or more **Chapters**. 
* Each chapter has one or more **Sections**.

*fresfolio* uses Flask as a backend and Vue3 as a frontend.

## Installation

```
pip install fresfolio
```

## Documentation

You can read the full documentation here: [https://fresfolio.readthedocs.io](https://fresfolio.readthedocs.io/en/latest/)

# Project Status: Under Heavy Development

This project is currently under active and heavy development. Features, APIs, and documentation are subject to change at any time.

