note package

Submodules

note.client module

class note.client.Note_Client

Bases: object

This is the client side library to interact with the note server

Encrypt()

Send(msg)

Add a note to the database on the server :param msg: The text of the note. :type msg: str :param tags: A list of tags to associate with the note. :type tags: list :returns: The message from the server :rtype: str

note.db_api module

class note.db_api.dbBaseClass

Bases: object

addItem(itemType, itemContents, itemID=None)

deleteItem(itemID)

getItem(itemID)

makeBackupFile(dstPath, fileName)

searchForItem(searchInfo, resultLimit=20, sortBy='relevance')

note.mongo_driver module

class note.mongo_driver.mongoDB(dbName, uri=None)

Bases: note.db_api.dbBaseClass

addItem(itemType, itemContents, itemID=None)

Parameters:

• itemType (str) – The type of the item, note, place, todo
• itemContents (dict) – A dictionary of the item contents
• itemID (int) – When editing a note, send the ID along with it

deleteItem(itemID)

Desc:Deletes item with ID = itemID, takes care of IDs collection Parameters:itemID (int) – The item ID to delete Raises:ValueError Returns ID:The ID of the deleted item Rval:int

getAllItemTypes()

Desc:Fetches a list of item types Returns:A list of item types: Rval:list

getByTime(startTime=None, endTime=None)

Desc:

Get all the notes in the given time window

Parameters:

• startTime (int) – The begining of the window
• endTime (int) – The end of the window

Returns:

A list of IDs

Ravl:

list

getDone(done)

Desc:Fetches a list of all the done ToDs Parameters:done (bool) – done or undone? Returns:A list of matching IDs Rval:list

getItem(itemID)

Desc:

Given an ID return the note JSON object {u’noteText’: u’note8’,

u’ID’: 3.0, u’tags’: [u‘8’], u’timestamps’: [1381719620.315899]}

Parameters:

itemID (int) – The item ID, an integer

Returns:

The matching note

Rval:

int

getItemType(itemID)

Desc:Given an itemID, return the “type” i.e. the collection it belongs to. Parameters:itemID (int) – The item ID, an integer Returns:The note type Rval:str

getNewID()

Desc:Get a new ID by either incrementing the currentMax ID or using an unusedID Returns:A new, valid, ID Rval:int

makeBackupFile(dstPath, fileName)

Parameters:

• dstPath (str) – The destination path of the backup file
• fileName (str) – The filename to use

searchForItem(searchInfo, resultLimit=20, sortBy='relevance')

Desc:

Given a search term returns a list of results that match that term:

[{u’score’: 5.5,

u’obj’: {u’noteText’: u’note8’,

u’ID’: 3.0, u’timestamps’: [1381719620.315899]}}]

Parameters:

searchInfo (str) – The search term

Returns:

A list of matching notes

Rval:

list

verify()

Desc:Verifies the integrity of the database, specifically checks the values for unusedIDs and currentMax Returns:A boolean indicating whether the database is valid or not Rval:bool

note.note_printer module

class note.note_printer.Note_Printer

Bases: object

Print()

print_OK()

print_error()

print_search()

note.server module

class note.server.Note_Server(db_name='note')

Bases: object

Check_Message(msg)

Verifies the message is a valid note message

Handle_Delete(msg)

Param:msg the JSON message from the client Returns:The reply from the db driver Rvalue:str

Handle_ERROR(msg)

Handle_Events(events)

Handle events from poll()

Events:A list of tuples form zmq.poll() Returns:None

Handle_Get(msg)

Param:msg the JSON message from the client Returns:The reply from the db driver Rvalue:str

Handle_NewNote(msg)

Handle a new note.

Parameters:msg (dict) – the received note Returns:The message to reply with Return type:str

Handle_Place(msg)

Handle_Receive(msg)

Handle a received message.

Parameters:msg (str) – the received message Returns:The message to reply with Return type:str

Handle_Search(msg)

Handle a search.

Parameters:msg (dict) – the received search Returns:The message to reply with Return type:str

Run()

Wait for clients to connect and service them

Returns:None

note.sql_driver module

class note.sql_driver.sqliteDB

Bases: note.db_api.dbBaseClass

addItem(itemType, itemContents)

deleteItem(itemID)

getItem(itemID)

makeBackupFile()

searchForItem(searchInfo)

note.util module

note.util.scrubID(ID)

Parameters:ID – An ID that can be of various types, this is very kludgy Returns:An integer ID

note.util.which(bin_name)

Parameters:bin_name – the name of the binary to test for (e.g. vim) Returns:True or False depending on wether the binary exists

note.web module

note.web.Delete(*args, **kwargs)

note.web.NewContact(*args, **kwargs)

note.web.NewNote(*args, **kwargs)

note.web.NewTodo(*args, **kwargs)

note.web.Notes(*args, **kwargs)

note.web.authenticate()

Sends a 401 response that enables basic auth

note.web.check_auth(username, password)

This function is called to check if a username / password combination is valid.

note.web.main()

note.web.newPlace(*args, **kwargs)

note.web.parseArgs()

note.web.requires_auth(f)

note.web.search(*args, **kwargs)

note.web.start(*args, **kwargs)

Module contents