Skip to main content

A simple note-taking CLI application

Project description

Donno

A simple note-take CLI application.

Install

pip install donno

Usage

don add        # create a new note
don list       # list existing notes
don search nim thunder    # search notes contains "nim" and "thunder"
don edit 3     # edit note #3 in note list or searching results
don delete 3   # delete note #3 in note list or searching results
don backup     # backup notes to remote repository
don restore    # restore notes from remote repository
don preview 3  # preview note #3 in console editor
don pv 3       # preview note #3 in browser
don ads -n nim -t config -c compile  # search notes which "nim" in its title, "config" in tags and "compile" in contents
don ads -r "[nim|thunder]"  # search notes contains "nim" or "thunder"
don publish    # publish notes to blog

Note: pv command depends on pandoc and a browser.

Add attachments in a note

You can add attachments in your notes. They could be image files, which are added by ![<image-file-name>](), or other files, which are added by [<attachment-file-name>]() (without exclamation mark ahead, like common markdown links).

The attachment file specified in the link must exist in the folder you add the note (the folder you run don a), or "attachment file not exists" error will be raised.

Under the hood

When you save a note and quit the editor, donno will scan all [<filename>]() pattern in the note. If the <filename>s exist in the current folder, donno do the following things:

  1. Generate a <internal-name> for each attachment;
  2. Copy each file to <notes-repo>/resources folder (get the path of <notes-repo> with don conf get repo) with their <internal-name>s;
  3. Update the link in the note from [<filename>]() to [<filename>](<internal-name>)

The <internal-name> is composed of 5 parts:

  1. Prefix resources/, for all attachments are saved in this folder in <notes-repo>
  2. <note-name>
  3. att
  4. Order number
  5. File extension of original file

For example, if you add the following attachments in the note with filename note201118140711.md:

![myimage.png]()
[mydoc.pdf]()

They will be updated to:

![myimage.png](resources/note201118140711att1.png)
[mydoc.pdf](resources/note201118140711att2.pdf)

If the attachment file doesn't exist in the current folder, donno will give a warning:

File myimage.png does not exist in the current folder.
You can run `don e ...` at the folder where myimage.png exists.

Configuration

File path: ~/.config/donno/config.json

Configuration Items

General

  • app_home: root folder of donno data files. Default: ~/.donno
  • repo: folder to save all note files and resource files. Default: $app_home/repo
  • editor: which application to use to create/update note. Default: nvim
  • viewer: which application to use to view notes in console. Default: nvim -R
  • default_notebook: default notebook name for a new note. Default: /Diary
  • editor_envs: environment variables of the editor. For example, env XDG_CONFIG_HOME is used by neovim to load config/plugins to parse markdown files. Default: ~/.config

Blog

  • url: blog url
  • publish_cmd: command to publish notes to blog

Manage Configurations

don conf get                # list all current configurations
don conf get edtior         # get which editor to use
don conf set editor nvim    # set the editor, make sure you've installed it
don conf set default_notebook /Diary/2020

# set nested attribute:
don conf set editor_envs.XDG_CONFIG_HOME $HOME/Documents/sources/vimrcs/text

# restore default values of configurations:
don conf restore

Update and uninstall

pip install --upgrade donno
pip uninstall donno

Some notes

Install in virtual environment

For those who don't want install apps in global environment, install it in a virtual environment:

mkdir ~/apps/donno
cd ~/apps/donno
python -m venv env
. env/bin/activate
pip install donno

cat << EOF >> ~/.zshrc
function dn() {
  source $HOME/apps/donno/env/bin/activate
  don $@
  deactivate
}
EOF

Now the command is dn instead of don.

Roadmap

  1. Basic note-taking functions: add, delete, list, search, view, update notes

  2. Configuration module: see Configuration;

  3. Preview: render markdown notes to HTML and previewed in browser

  4. Support adding attachments into notes, espeicially images

  5. Add logging system, distinguish application (for end user) and debugging (for developer) logs

  6. Synchronize notes between hosts (based on VCS, such as git)

  7. Import/Export from/to other open source note-taking apps, such as Joplin

  8. Advanced search function: search by title, tag, notebook and content

  9. Search with regular expression

  10. Basic publishing module: publish to blog, such as github.io

  11. Advanced publishing function: publish specific note, or notes in specific notebook

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for donno, version 0.6.0
Filename, size File type Python version Upload date Hashes
Filename, size donno-0.6.0-py3-none-any.whl (8.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size donno-0.6.0.tar.gz (7.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page