pynoteslib package¶

pynoteslib module¶

PYNOTESLIB the Python library implementation of Standard Unix Notes.

It implements the notes() class and a number of functions to manipulate notebooks and configuration.

NOTES allows the user to have multiple notebooks and even a default notebook. The initial notebook is called simply ‘Notes’ and all notes created or imported will default to this notebook.

The user may create additional notebooks at any time and choose to USE a preferred notebook where all future notes will be created until the user chooses to USE another notebook. The user can quickly switch back to a DEFAULT notebook by not specifying which notebook to USE.

Full documentation can be found at https://pynoteslib.readthedocs.io/en/latest/

class pynoteslib.Notes[source]¶

Bases: object

Object for managing a noteand it’s plaintext/ciphertext

Variables

title – title of note
filename – filename of note
fullpath – full pathname of file containing note
ciphertext – string containing the ciphertext of note
plaintext – string containing the plaintext of note

NB only one of either ciphertext or plaintext should be set at any time.

Notes class constructor. Do not use directly use one of the following functions:

load_note_from_file(note_filename) note_from_ciphertext(str) note_from_plaintext(str) import_note_from_file(filename)

add_extension()[source]¶

Appends ‘.asc’ to the basename of self.filename

Param: none
Returns: none

property ciphertext¶: ciphertext property of note

decrypt()[source]¶

Encrypts self.plaintext -> selfciphertext and resets self.plaintext

Returns: self.ciphertext
Return type: str

encrypt()[source]¶

Encrypts self.plaintext -> selfciphertext and resets self.plaintext

Returns: self.ciphertext
Return type: str

property filename¶: filename property of note

get_extension()[source]¶

Returns extension of self.filename

Param: none
Returns: self.filename’s extension
Return type: str

import_from_file()[source]¶

Loads plaintext from file self.filename (fullpath)

Param: none
Returns: none

is_encrypted()[source]¶

Check if note is encrypted

Param: none
Returns: True if self.ciphertext != ‘’

load_ciphertext()[source]¶

Loads ciphertext from file self.filename

Param: none
Returns: none

load_plaintext()[source]¶

Loads plaintext from file self.filename

Param: none
Returns: none

property plaintext¶: plaintext property of note

remove_extension()[source]¶

Removes extension from self.filename

Param: none
Returns: none

save_ciphertext()[source]¶

Saves Ciphertext of note to file named self.filename adding the extension ‘.asc’

Param: none
Returns: none

save_plaintext()[source]¶

Saves Plaintext of note to file named self.filename

Param: none
Returns: none

property title¶: title property of note

pynoteslib.backup(conf)[source]¶

Backup configuration, notes and notebook to tar file in the directory above the NOTESDIR (default = HOME)

Param: none
Returns: The return code of tarfile creation/write
Return type: bool

pynoteslib.change_spaces(string)[source]¶

Returns a string with all spaces in ‘string’ have been replaced with ‘_’

Parameters: string – String to have spaces replaced
Type: str
Returns: Supplied ‘string’ with spaces replaced with ‘_’
Return type: str

pynoteslib.config_file_exists()[source]¶

Checks to see if NOTESDIR/config file exists

Param: none
Returns: True if NOTESDIR/config file exists
Return type: bool

pynoteslib.copy_to_notebook(filename, notebook)[source]¶

Copies note from current USE’d notebook to another notebook

Parameters

filename (str) – The filename of note to be copied
notebook (str) – The target notebook name

Returns

True on successful copy

Return type

bool

pynoteslib.create_config()[source]¶

Create directory structure under NOTESDIR and TOML config file NOTESDIR/config

Param: none
Returns: none

pynoteslib.create_notebook(title)[source]¶

Create a notebook with foldername ‘title’

Parameters: title (str) – title of notebook
Returns: True on successful creation of notebook’s folder
Return type: bool

pynoteslib.default_notebook(notebook)[source]¶

Set a notebook as th edefault notebook (use_notebook() defaults to the DEFAULT notebook if ‘’ instead of a notebook title)

Parameters: notebook (str) – notebook to set as default
Returns: Returns True on success of write_config() with updated configuration
Return type: bool

pynoteslib.delete_note(filename)[source]¶

Deletes a note on disk inside the currently USE’d notebook

Parameters: filename (str) – A string containing the filename of note to be deleted
Returns: True on successful deletion of note
Return type: bool

pynoteslib.delete_notebook(title)[source]¶

Deletes an existing notebook oldtitle and included notes

Parameters: title (str) – Title of existing notebook
Returns: True on successful deletion of notebook’s folder
Return type: bool

pynoteslib.duplicate_note(oldname, newname)[source]¶

Duplicates an encrypted note on disk inside the currently USE’d notebook

Parameters

oldname (str) – The new filename for note
newname (str) – The new filename for note

Returns

True on successful rename of note

Return type

bool

pynoteslib.duplicate_notebook(oldtitle, newtitle)[source]¶

Duplicates an existing notebook oldtitle as newtitle with all notes duplicated.

Parameters

oldtitle (str) – Title of existing notebook
newtitle (str) – New Title for notebook

Returns

True on successful duplication of notebook’s folder

Return type

bool

pynoteslib.get_config()[source]¶

Reads configuration from the TOML file NOTESDIR/config. If ‘config’ file does not exist, calls create_config() to create

Param: none
Returns: Configuration loaded from the TOML file ‘config’
Return type: dict

pynoteslib.get_config_file()[source]¶

Get the fullpath to the app configuration file NOTESDIR/config

Param: none
Returns: fullpath to the config file fullpath
Return type: str

pynoteslib.get_default_gpg_key()[source]¶

Locates the first private key in the users GPG keyring

Under testing conditions it returns the test@pynoteslib GPG key shown in _default_config[‘gpgkey’] to use in testing

In normal conditions it returns the first private gpgkey found in the user’s keyring

Param: none
Returns: The first GPG key ID found in user’s keyring
Return type: str

pynoteslib.get_default_notebook()[source]¶

Reads config file and returns what notebook is the default

Param: none
Returns: The name of the default notebook
Return type: str

pynoteslib.get_fullpath(name)[source]¶

Return full pathname of passed parameter

Parameters: name (str) – A notebook, filename (eg. ‘config’) or expression`
Returns: Returns full path for ‘name’ UNDER the NOTESDIR
Return type: str

pynoteslib.get_note_fullpath(note, notebook='')[source]¶

Returns the full pathname of a note within the currently USE’d Notebook

Parameters: note – The title (or filename) of a note
Type: str
Returns: Returns full path to a note
Return type: str

pynoteslib.get_notebooks()[source]¶

Returns a list of all notebooks in NOTESDIR

Param: none
Returns: A list[] of notebooks
Return type: list

pynoteslib.get_notes(notebook='')[source]¶

Returns a list of note in given notebook (or the USE’d notebook)

Parameters: notebook (str, optional) – Specified notebook to USE, defaults to DEFAULT notebook
Returns: list of notes in notebook; or [] for invalid notebook
Return type: list

pynoteslib.get_notesdir()[source]¶

Gets the fullpath to the main app directory

Param: none
Returns: the app’s home folder (either NOTESDIR or $HOME/.notes)
Return type: str

pynoteslib.get_use_notebook()[source]¶

Reads config file and returns what notebook is currently used notebook

Param: none
Returns: The currently ‘use’d notebook (where notes will be created)
Return type: str

pynoteslib.import_note_from_file(filename)[source]¶

Imports note from file

Parameters: filename (str) – filename to be imported
Returns: note
Return type: class

pynoteslib.load_note_from_file(filename)[source]¶

Opens file and assigns contents to plaintext or ciphertext

Parameters: filename (str) – fullpath of filename
Returns: returns success or failure
Return type: bool

pynoteslib.move_to_notebook(filename, notebook)[source]¶

Moves a note from the currently USE’d notebook to another notebook

Parameters

filename (str) – The filename to move
notebook – The target notebook name

Returns

True on successful move of note to notebook

Return type

bool

pynoteslib.new_key(newkey)[source]¶

Change encryption key for all notes. Traverses filesystem in NOTESDIR/[all notebooks]. Decrypts and re-encrypts with specified newkey

Parameters: newkey (str) – New valid gpg privakey keyid
Returns: Returns True on re-encryption; False on invalid private key
Return type: bool

pynoteslib.note_from_ciphertext(ciphertext)[source]¶

Creates note from supplied ciphertext

Parameters: ciphertext (str) – ciphertext of note
Returns: note
Return type: class

pynoteslib.note_from_plaintext(plaintext)[source]¶

Creates note from supplied plaintext

Parameters: plaintext (str) – plaintext of note
Returns: note
Return type: class

pynoteslib.pynoteslib_version()[source]¶: Returns version no of library

pynoteslib.rename_note(oldname, newname)[source]¶

Renames a note on disk inside the currently USE’d notebook

Parameters

oldname (str) – The old filename for note
newname (str) – The new filename for note

Returns

True on sucessful renaming of note

Return type

bool

pynoteslib.rename_notebook(oldtitle, newtitle)[source]¶

Renames existing notebook oldtitle as newtitle

Parameters

oldtitle (str) – Title of existing notebook
newtitle (str) – New Title for notebook

Returns

True on successful rename of notebook’s folder

Return type

bool

pynoteslib.use_notebook(notebook='')[source]¶

Reads config file and returns the DEFAULT notebook. If no notebook is specified then the USE notebook is set to the DEFAULT notebook

Parameters: notebook (str) – Title of notebook to USE, optional
Returns: Returns True on successful write of new config file
Return type: bool

pynoteslib.validate_gpg_key(gpgkeyid)[source]¶

Validates the specified gpgkeyid is a private key in the user’s keyring

Param: none
Returns: True if gpgkey is a valid private key
Return type: bool

pynoteslib.write_config(conf)[source]¶

Writes app configuration to TOML file NOTESDIR/config (see _default_config as a sample structure)

Parameters: conf – Dictionary containing configuration data
Type: dict
Returns: True on successful write of configfile
Return type: bool