Metadata-Version: 2.1
Name: donote
Version: 0.0.2
Summary: donote
Home-page: https://github.com/FedeClaudi/knowledge_base
Author: Federico Claudi
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.6,
Description-Content-Type: text/markdown
Requires-Dist: pyinspect
Requires-Dist: click
Requires-Dist: rich (>=9.0.0)
Provides-Extra: dev
Requires-Dist: coverage-badge ; extra == 'dev'
Requires-Dist: click ; extra == 'dev'

# knowldege_base
The minimalist note editor for your terminal. 


**Create** notes...
**Edit** notes...
**Save** notes...

![](kb.png)


`knowledge` base is a python implementation of a minimalist note editor for your terminal.
It facilitates creating, editing and managing notes as `markdown` files.

As such, it provides a CLI with the followng sintax:
```shell
kb <command> <note_name (optional)> <tag (optional)>
```

The **commands** include:

- `l` or `list` to list all notes
- `show <note_name>` to render a single note in the terminal
- `e/edit <note_name>` to edit an existing note
- `rm/remove <note_name>` to delete a note
- `n/new <note_name>` to create a new note with a given Name
- `t/tag <note_name> <tag>` to add a new tag to an existing note
- `untag <note_name> <tag>` to remove a tag to an existing note


Editing a note opens the markdown file using `nano`, other editors can be used to edit the `.md` files externally.


## Installation
```
    pip install knowledgebase
```

**Disclaimer**: `knowledgebase` is a personal project, as such the path to where the notes are saved on my machine are hardcoded. If you want to use `knowledgebase` let me know and we can improve this (or you can fork this repository and alter the paths).


**Built with `rich` and `pyinspect`**


