infoflow

Visualisation and description of Jelle’s information process workflow

User Guide

Intention of this project

I created this project because I want a personal knowledge management system to efficiently collect, organize, and retrieve information from various sources (books, articles, videos, podcasts, research papers, etc.). I usually can’t immediately consume the information I encounter. By building a clear workflow of actions and tools I use to solve the problem of having more interesting information than I can process. By creating a structured four-phase workflow (Collect, Retrieve, Consume, Refine) I aim to make it as easy and fast as possible to store items when I encounter them and later find relevant information when I need it based on my current interests or projects.

I want to implement this as Python classes and visualize it with Graphviz because this approach provides flexibility to easily modify tools and processes, unlike static text or diagram-based approaches.

Installation of infoflow

cd {folder where you want to create the folder for this project}
git clone git@github.com:Hopsakee/infoflow.git
cd infoflow
uv sync
uv run main.py

This starts a local server where the application will be run.

Developer Guide

If you are new to using nbdev here are some useful pointers to get you started.

Install infoflow in Development mode

# make sure infoflow package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to infoflow
$ nbdev_prepare

Usage

Installation

Install latest from the GitHub repository:

$ pip install git+https://github.com/Hopsakee/infoflow.git

or from conda

$ conda install -c Hopsakee infoflow

or from pypi

$ pip install infoflow

Documentation

Documentation can be found hosted on this GitHub repository’s pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

How to use

Fill me in please! Don’t forget code examples:

1+1