basant/readme.md

45 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

2021-11-30 06:24:51 -08:00
# Basant
2021-11-29 04:26:21 -08:00
2021-12-22 01:10:38 -08:00
I collect a lot of information. Basant is a tool to help me refine, reflect and understand the vast troves of data I generate.
2022-03-17 08:03:06 -07:00
Think of it like a unified front end to all the data sources I have.
From these vairous outputs can be created, with the end goal being a variety of ways to viualize, understand and share my data: matrix bot to publish to The Feed, a front page showing latest changes, and of course, my website.
2021-12-22 01:10:38 -08:00
I'd like to be able to draw 'links' or annotations between the tags I use across various different pieces of software,
2021-11-30 06:24:51 -08:00
These are the tools I use construct the space.
2021-12-22 01:10:38 -08:00
The map is not the teritory.
2021-11-30 06:24:51 -08:00
## Architecture
2021-12-22 01:10:38 -08:00
Basant is made from various different data sources, each with their own folder.
Each data source will have a `grab`, `build`, raw & output. `grab` gets the raw data, and `build` makes it into HTML
Depending on the data source, there may be additional partial/ asset/ media/ folders in the directory. I'm not yet sure how to cascade these and build upwards.
Some of those HTML files get published
2021-11-30 06:24:51 -08:00
2021-12-22 01:10:38 -08:00
For better ideas look into [HPI](https://github.com/karlicoss/hpi) and how it's structured
2021-11-30 06:24:51 -08:00
2022-03-17 08:03:06 -07:00
### Grab
Currently `kitaab-public` requires a local copy of unfiltered kitaab stored in ~/vimwiki.
However, flakes can use private git repos, so maybe there's a way to build this bit too using nix?? TODO
there needs to be a .vimwiki_tags file there (which can be built in vimwiki using `:VimwikiRebuildTags`; how to automate this?) TODO
2021-12-22 01:10:38 -08:00
It'll grab the relevant files, censor them, and then add them to raw/
2022-03-17 08:03:06 -07:00
`kitaab-local` should run the same thing, but without the filtering and censoring
2021-11-29 04:26:21 -08:00
2021-11-30 06:24:51 -08:00
streams is a big TODO
- wallabag
- shaarli
- rss
2021-12-22 01:10:38 -08:00
- kobo
- tasks
- habits
2021-11-30 06:24:51 -08:00
### Build
TODO
depending on the file location (which is in turn determined by input source) a specific template gets applied
links get made
and it saves it to output
### Publish
2022-03-17 08:03:06 -07:00
packaged `devShell`, `module` and `derivation` for basant created, but not quite working yet. Slowly understanding more about nix, but down a terrible rabbit-hole now with python and setuptools...