tastic.workspace.sync (class) ∞
-
class
tastic.workspace.
sync
(log, workspaceRoot, workspaceName, syncFolder, settings=False, editorialRootPath=False, includeFileTags=True)[source] ∞ The worker class for the sync module
- Key Arguments:
log
– loggersettings
– the settings dictionaryworkspaceRoot
– path to the root folder of a workspace containing taskpaper filesworkspaceName
– the name of the workspacesyncFolder
– path to a folder to host your synced tag taskpaper documents.editorialRootPath
– the root path of editorial’s dropbox sync folder. Default FalseincludeFileTags
– if the tag is in the filepath (e.g. /@due/mytasks.taskpaper) include all items the file in that tag set. Default True
Usage:
To setup your logger, settings and database connections, please use the
fundamentals
package (see tutorial here).To initiate a sync object, use the following:
from tastic.workspace import sync tp = sync( log=log, settings=settings, workspaceRoot="/path/to/workspace/root", workspaceName="myWorkspace", syncFolder="/path/to/sync/folder", includeFileTags=True ) tp.sync()
After this it is simply a matter of running
tp.sync()
to sync the sync-tag set into a taskpaper document in the syncFolder called<workspaceName>-synced-tasks.taskpaper
-
__init__
(log, workspaceRoot, workspaceName, syncFolder, settings=False, editorialRootPath=False, includeFileTags=True)[source] ∞
Methods
__init__
(log, workspaceRoot, workspaceName, ...)sync
()sync the tasks tagged with a tag in the sync-tags set to index taskpaper document and HTML page