Skip to main content

command line tool for quickly writing journals

Project description

نسخه فارسی این سند

makenote

a command line tool for making diary or journals.

installation

there are a few methods for installation

using pip

easiest way is to install it using pip:

  1. install package
pip install makenote

for some new Gnu distros you need to use pipx.

pipx install makenote
  1. add ~/.local/bin to path if needed. (help)

build for pip

  1. build the package
pip install setuptools wheel
git clone 'https://github.com/ekm507/makenote'
cd makenote
python3 setup.py bdist_wheel
  1. install the package
pip install ./dist/*.whl

usage

adding notes

to add note to a specified notebook, run this:

makenote [-t <notebook_name>] <note_text>

in which note text is the note you want to be added.

for example:

makenote I am reading page 754 of the book

if you run this tool with no text, it will get note text from a simple prompt editor. write your text and then hit Alt+Enter or ctrl+D.

$ makenote

it was a great day.
I had a pizza with my friend. (ctrl+D)

1728 - Tue, 10 Bah 1402 18:55:25 - journals - note saved!

if you do not specify notebook name, then note will be stored in default notebook which is journals. you can change it in config file.

creating notebooks

this tool uses different notebooks for storing notes.
for example you can classify your notes in "journals", "tasks", "work", etc.

to create a notebook, run this:

makenote --create <notebook_name>

in which <notebook_name> is the name of notebook you want to be created.

listing notebooks

to get a list of notebooks you have created, run this:

makenote --list

showing records

to see the notes you have stored in a notebook, run this:

makenote --show

if you do not specify notebook name, the default notebook will be shown. you can specify it with -t switch:

makenote --show -t <notebook>

getting help

run command below to get a list of switches:

makenote -h

configuration

a file named makenote.conf is copied into makenote install dir. you can edit this file to get what you want.

export all notes

database files are stored in path specified in config file. which by default is below:

~/.local/share/makenote/databases/

for backing notes up, just copy the files somewhere safe.

for restoring, just copy the database into the database path again.

Project details


Download files

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

Source Distribution

makenote-4.4.2.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

makenote-4.4.2-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file makenote-4.4.2.tar.gz.

File metadata

  • Download URL: makenote-4.4.2.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for makenote-4.4.2.tar.gz
Algorithm Hash digest
SHA256 6ee07a8a0fe12578d4f56b98b581cd16c6506e9ed0d3cd72b8d163aa3c6b3226
MD5 fbc9d352a326c8e7cf1dd9df2643dacc
BLAKE2b-256 9c13056f3ee1abebea5e024fedc5d05ee544668908ebe1c257747118fd64637b

See more details on using hashes here.

File details

Details for the file makenote-4.4.2-py3-none-any.whl.

File metadata

  • Download URL: makenote-4.4.2-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for makenote-4.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 73fc6dcc7f0186833bb77b387ca716923c8c27661c9410e1fc99fb7a5dc64b65
MD5 2ae910f0be912fe22aadf8e4b59ba8b9
BLAKE2b-256 e880a0efa50ea9e5b2033c6ddcfb7159e6c0c3661b1f45f8684c10478592d155

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page