pynote - manage notes on the commandline

rumpelsepp · 2013-12-20 13:11:31

Hi there,

two weeks ago I started a project to manage notes on the commandline. Because I wrote it in python I decided to call it pynote.

Github: https://github.com/rumpelsepp/pynote
Bugtracker: https://github.com/rumpelsepp/pynote/issues
Docs: https://docs.sevenbyte.org/pynote
Pypi Package: https://pypi.python.org/pypi/pynote/
AUR Package: https://aur.archlinux.org/pkgbase/pynote/

This is my very first open source project so please avoid too hard criticism. If you have suggestions or questions use my redmine bugtracker or just post in this forum thread. :-)

Last edited by rumpelsepp (2016-05-20 14:00:25)

bohoomil · 2013-12-20 13:58:30

It is a really nice app: exactly what I have been looking for. Thank you very much!

rumpelsepp · 2013-12-20 14:06:47

bohoomil wrote:

It is a really nice app: exactly what I have been looking for. Thank you very much!

Very nice to read something this. Thank you! :)

stewie · 2013-12-20 17:53:12

This looks like an interesting program. While I have not tried it yet, I did
notice a typo on https://pypi.python.org/pypi/pynote/0.1b3

trash to ensure you do not loose any data

I would change that to

trash to ensure you do not lose any data

rumpelsepp · 2013-12-20 21:44:29

stewie wrote:

This looks like an interesting program. While I have not tried it yet, I did
notice a typo on https://pypi.python.org/pypi/pynote/0.1b3
trash to ensure you do not loose any data
I would change that to
trash to ensure you do not lose any data

oh... thanks! I will fix it.

stewie · 2013-12-21 01:21:00

This is great for taking some notes and keeping them all together in one place.
I do have a request though, when viewing a note

note show 1

If I wanted to save the note outside of pynote without the header, I would have to do something like this.

note show 1 |  tail -n +9 > some_note

Is it possible for a print or quiet option without the header?

The header I'm talking about from container.py

        string = ('+-------------------------------------------------+\n'
                  '| title:    {0}\n'
                  '| created:  {1}\n'
                  '| updated:  {2}\n'
                  '| revision: {3}\n'
                  '| uuid:     {4}\n'
                  '+-------------------------------------------------+\n'
                  '\n'
                  '{5}\n').format(self.title, created, updated, self.revision,
                                  self.uuid, self.content)
        return string

I could probably hack something up myself if need be. Thanks

rumpelsepp · 2013-12-21 17:23:14

stewie wrote:

If I wanted to save the note outside of pynote without the header, I would have to do something like this.
note show 1 |  tail -n +9 > some_note
Is it possible for a print or quiet option without the header?

Maybe like this?

note show 1 -n
note show 1 --no-header

Do we need an export/import function to plain text files?

Last edited by rumpelsepp (2013-12-21 17:24:48)

stewie · 2013-12-21 18:47:18

Maybe like this?

note show 1 -n
note show 1 --no-header

That would work for me.

Do we need an export/import function to plain text files?

I think that would be a great idea. That way would help to keep a bunch of misc. text files together in one place,
or if you needed to save a note somewhere else.

rumpelsepp · 2013-12-22 16:54:41

stewie wrote:

Maybe like this?
note show 1 -n
note show 1 --no-header
That would work for me.

Ok, I will implement this. I think I will put it in the next beta release.

stewie wrote:

Do we need an export/import function to plain text files?
I think that would be a great idea. That way would help to keep a bunch of misc. text files together in one place,
or if you needed to save a note somewhere else.

I will adopt this in the future version 0.2. But I need some help and discussion here.

My thoughts about import/export:

Implement the --no-header option as well.
How do we export the metadata? I think we need at least the uuid to be able to sync changes back. My idea about syncing is:
- Export a note to a plain text file.
- Change the textfile and import it again.
- The note is recognized by the uuid and a new revision is created if there are any changes.
- The other way round is also possible.
Maybe export the note and a json file (same filename) with the metadata. With --no-header passed just neglect the json file. Any better ideas?
How should the command line interface look like?
Do we need other data formats for exporting? (YAML, JSON, CSV, ...)

rumpelsepp · 2013-12-22 18:05:35

stewie wrote:

Maybe like this?
note show 1 -n
note show 1 --no-header
That would work for me.

I implemented this, see here: http://cgit.sevenbyte.org/pynote/commit … 539de2375f
It should be available in the most recent pynote-git package.

I noticed that the argparse code in pynote.__main__ is really ugly...

stewie · 2013-12-24 01:34:21

Thanks for the --no-header option, it works great.

rumpelsepp wrote:

I will adopt this in the future version 0.2. But I need some help and discussion here.
My thoughts about import/export:
Implement the --no-header option as well.
How do we export the metadata? I think we need at least the uuid to be able to sync changes back. My idea about syncing is:
Export a note to a plain text file.
Change the textfile and import it again.
The note is recognized by the uuid and a new revision is created if there are any changes.
The other way round is also possible.
Maybe export the note and a json file (same filename) with the metadata. With --no-header passed just neglect the json file. Any better ideas?
How should the command line interface look like?
Do we need other data formats for exporting? (YAML, JSON, CSV, ...)

I'm not sure what would be a better idea for that. The command line interface works good for me, I guess it
depends if you need to add more features or not.

Maybe it would be best if there was some kind of exports template. If someone needs a different type of export,
it would be easier to code a new front|back end for it. I personally don't need any other format for myself right now.

rumpelsepp · 2013-12-24 13:51:31

I decided to release pynote 0.1 today is a christmas present. The Release Notes and (little) update instructions are here: http://redmine.sevenbyte.org/news/8

Merry Christmas!

Last edited by rumpelsepp (2013-12-24 14:03:05)

nsmathew · 2013-12-28 07:38:11

Hi, is there any plan to introduce an option to show all the notes, like 'note show all' ? Also is there a way to edit the title?
And thanks for the software!

rumpelsepp · 2013-12-28 10:28:38

nsmathew wrote:

Hi, is there any plan to introduce an option to show all the notes, like 'note show all' ?

What shall this option do in detail?

nsmathew wrote:

Also is there a way to edit the title?

The edit of the title has not been implemented yet. I will add a ticket for version 0.2. (-> http://redmine.sevenbyte.org/issues/292)

$ note edit 1 --title

nsmathew wrote:

And thanks for the software!

:-)

nsmathew · 2013-12-28 10:37:34

For 'note show all' i meant like show the detailed view of the notes, but for all the active notes instead of just 1.

rumpelsepp · 2013-12-28 10:42:14

nsmathew wrote:

For 'note show all' i meant like show the detailed view of the notes, but for all the active notes instead of just 1.

Ok. I have created a ticket as well. (-> http://redmine.sevenbyte.org/issues/293)

nsmathew · 2013-12-28 16:24:22

Thanks, will wait for the next version.

rumpelsepp · 2013-12-28 16:36:48

nsmathew wrote:

Thanks, will wait for the next version.

Jo.
Feel free to create any patches if you want. (see here: http://cgit.sevenbyte.org/pynote/tree/CONTRIBUTING) :-)
The next version will take a few weeks because I have exams in university next months...

Last edited by rumpelsepp (2013-12-28 16:37:16)

rumpelsepp · 2014-01-03 09:57:09

Today I finished the german localisation. If you are from a german speaking country you should see a translated help page in the most recent pynote-git package.
If somebody wants to translate pynote into another language just let me know.

Vxed · 2014-01-08 13:09:28

Nice job on your first project.

I have been looking for a console based note management application and this is a great start. I am kinda looking for a Evernote replacement that is console based and using local storage instead of cloud sync.

Suggestion:

Add the ability to create notebooks or separated lists.

 note list all

- This could list all the notes in the json data file

 note list list1

- This could list all the notes in the list1 list/notebook

rumpelsepp · 2014-01-08 14:04:38

Vxed wrote:

Nice job on your first project.
I have been looking for a console based note management application and this is a great start. I am kinda looking for a Evernote replacement that is console based and using local storage instead of cloud sync.
Suggestion:
Add the ability to create notebooks or separated lists.
 note list all
- This could list all the notes in the json data file
 note list list1
- This could list all the notes in the list1 list/notebook

Thank you very much for your feedback!

I want to implement tags in future (every note object currently has an empty tag list, so we do not have to convert the json data in future). But I think your suggestion can be accomplished with tags, can't it?

$ note list -t TAG
$ note list --tags=TAG

Vxed · 2014-01-08 19:37:38

Yeah tags would also do this job well.

I look forward to seeing future updates to this project.

rumpelsepp · 2014-01-10 14:43:06

nsmathew wrote:

For 'note show all' i meant like show the detailed view of the notes, but for all the active notes instead of just 1.

I implemented this here: http://cgit.sevenbyte.org/pynote/commit … 40906a61f9
It is available in the updated pynote-git package.

note show --all

nsmathew · 2014-01-11 07:23:40

rumpelsepp wrote:

nsmathew wrote:
For 'note show all' i meant like show the detailed view of the notes, but for all the active notes instead of just 1.
I implemented this here: http://cgit.sevenbyte.org/pynote/commit … 40906a61f9
It is available in the updated pynote-git package.
note show --all

Thanks. Just tried it, this works fine.

rumpelsepp · 2014-01-12 11:54:42

nsmathew wrote:

Hi, is there any plan to introduce an option to show all the notes, like 'note show all' ? Also is there a way to edit the title?
And thanks for the software!

Implemented with http://cgit.sevenbyte.org/pynote/commit … daef526c43
Available in the most recent pynote-git package as well.

$ note edit KEY --title

Arch Linux

#1 2013-12-20 13:11:31

pynote - manage notes on the commandline

#2 2013-12-20 13:58:30

Re: pynote - manage notes on the commandline

#3 2013-12-20 14:06:47

Re: pynote - manage notes on the commandline

#4 2013-12-20 17:53:12

Re: pynote - manage notes on the commandline

#5 2013-12-20 21:44:29

Re: pynote - manage notes on the commandline

#6 2013-12-21 01:21:00

Re: pynote - manage notes on the commandline

#7 2013-12-21 17:23:14

Re: pynote - manage notes on the commandline

#8 2013-12-21 18:47:18

Re: pynote - manage notes on the commandline

#9 2013-12-22 16:54:41

Re: pynote - manage notes on the commandline

#10 2013-12-22 18:05:35

Re: pynote - manage notes on the commandline

#11 2013-12-24 01:34:21

Re: pynote - manage notes on the commandline

#12 2013-12-24 13:51:31

Re: pynote - manage notes on the commandline

#13 2013-12-28 07:38:11

Re: pynote - manage notes on the commandline

#14 2013-12-28 10:28:38

Re: pynote - manage notes on the commandline

#15 2013-12-28 10:37:34

Re: pynote - manage notes on the commandline

#16 2013-12-28 10:42:14

Re: pynote - manage notes on the commandline

#17 2013-12-28 16:24:22

Re: pynote - manage notes on the commandline

#18 2013-12-28 16:36:48

Re: pynote - manage notes on the commandline

#19 2014-01-03 09:57:09

Re: pynote - manage notes on the commandline

#20 2014-01-08 13:09:28

Re: pynote - manage notes on the commandline

#21 2014-01-08 14:04:38

Re: pynote - manage notes on the commandline

#22 2014-01-08 19:37:38

Re: pynote - manage notes on the commandline

#23 2014-01-10 14:43:06

Re: pynote - manage notes on the commandline

#24 2014-01-11 07:23:40

Re: pynote - manage notes on the commandline

#25 2014-01-12 11:54:42

Re: pynote - manage notes on the commandline

Board footer