tests: Explicitly mark unicode strings used for testing

[etc/taskwarrior.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 90cd94ba7c36abb9014e49baa43dc7d55468bcb8..dfddeb02a812e77bf945bed1199a1cb992f87c56 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -36,6 +36,11 @@ The default location is the same as taskwarrior's::
 
     >>> tw = TaskWarrior(data_location='~/.task', create=True)
 
 
     >>> tw = TaskWarrior(data_location='~/.task', create=True)
 

+The ``TaskWarrior`` instance will also use your .taskrc configuration (so that
+it recognizes the same UDAs as your task binary, uses the same configuration,
+etc.). To override the location of the .taskrc, use
+``taskrc_location=~/some/different/path``.
+

 Creating Tasks
 --------------
 
 Creating Tasks
 --------------
 


@@ -239,6 +244,27 @@ same Python object::
     >>> task3 == task1
     True
 
     >>> task3 == task1
     True
 

+Accessing original values
+-------------------------
+
+To access the saved state of the Task, use dict-like access using the
+``original`` attribute:
+
+    >>> t = Task(tw, description="tidy up")
+    >>> t.save()
+    >>> t['description'] = "tidy up the kitchen and bathroom"
+    >>> t['description']
+    "tidy up the kitchen and bathroom"
+    >>> t.original['description']
+    "tidy up"
+
+When you save the task, original values are refreshed to reflect the
+saved state of the task:
+
+    >>> t.save()
+    >>> t.original['description']
+    "tidy up the kitchen and bathroom"
+

 Dealing with dates and time
 ---------------------------
 
 Dealing with dates and time
 ---------------------------
 


@@ -312,7 +338,7 @@ are set in the same timezone:
     >>> t['due']
     datetime.datetime(2015, 2, 1, 19, 44, 4, 770001, tzinfo=<DstTzInfo 'Europe/Berlin' CET+1:00:00 STD>)
     >>> now.astimezone(pytz.utc)
     >>> t['due']
     datetime.datetime(2015, 2, 1, 19, 44, 4, 770001, tzinfo=<DstTzInfo 'Europe/Berlin' CET+1:00:00 STD>)
     >>> now.astimezone(pytz.utc)

-    datetime.datetime(2015, 2, 1, 18, 44, 4, 770001, tzinfo=<DstTzInfo 'Europe/Berlin' CET+1:00:00 STD>)
+    datetime.datetime(2015, 2, 1, 18, 44, 4, 770001, tzinfo=<UTC>)

     >>> t['due'] == now.astimezone(pytz.utc)
     True
 
     >>> t['due'] == now.astimezone(pytz.utc)
     True
 


@@ -376,14 +402,14 @@ You can use ``config_override`` keyword argument to specify a dictionary of conf
 Setting custom configuration values
 -----------------------------------
 
 Setting custom configuration values
 -----------------------------------
 

-By default, TaskWarrior does not use any of configuration values stored in
-your .taskrc. To see what configuration values are passed to each executed
+By default, TaskWarrior uses configuration values stored in your .taskrc.
+To see what configuration value overrides are passed to each executed

 task command, have a peek into ``config`` attribute of ``TaskWarrior`` object::
 
     >>> tw.config
     {'confirmation': 'no', 'data.location': '/home/tbabej/.task'}
 
 task command, have a peek into ``config`` attribute of ``TaskWarrior`` object::
 
     >>> tw.config
     {'confirmation': 'no', 'data.location': '/home/tbabej/.task'}
 

-To pass your own configuration, you just need to update this dictionary::
+To pass your own configuration overrides, you just need to update this dictionary::

 
     >>> tw.config.update({'hooks': 'off'})  # tasklib will not trigger hooks
 
 
     >>> tw.config.update({'hooks': 'off'})  # tasklib will not trigger hooks
 


@@ -424,20 +450,28 @@ Consenquently, you can create just one hook file for both ``on-add`` and
 This removes the need for maintaining two copies of the same code base and/or
 boilerplate code.
 
 This removes the need for maintaining two copies of the same code base and/or
 boilerplate code.
 

+In ``on-modify`` events, tasklib loads both the original version and the modified
+version of the task to the returned ``Task`` object. To access the original data
+(in read-only manner), use ``original`` dict-like attribute:
+
+    >>> t = Task.from_input()
+    >>> t['description']
+    "Modified description"
+    >>> t.original['description']
+    "Original description"

 
 Working with UDAs
 -----------------
 
 
 Working with UDAs
 -----------------
 

-Since TaskWarrior does not read your .taskrc, you need to define any UDAs
-in the TaskWarrior's config dictionary, as described above.
+Since TaskWarrior does read your .taskrc, you need not to define any UDAs
+in the TaskWarrior's config dictionary, as described above. Suppose we have
+a estimate UDA in the .taskrc::

 
 

-Let us demonstrate this on the same example as in the TaskWarrior's docs::
+    uda.estimate.type = numeric

 
 

-    >>> tw = TaskWarrior()
-    >>> tw.config.update({'uda.estimate.type': 'numeric'})
-
-Now we can filter and create tasks using the estimate UDA::
+We can simply filter and create tasks using the estimate UDA out of the box::

 
 

+    >>> tw = TaskWarrior()

     >>> task = Task(tw, description="Long task", estimate=1000)
     >>> task.save()
     >>> task['id']
     >>> task = Task(tw, description="Long task", estimate=1000)
     >>> task.save()
     >>> task['id']


@@ -448,7 +482,7 @@ This is saved as UDA in the TaskWarrior::
     $ task 1 export
     {"id":1,"description":"Long task","estimate":1000, ...}
 
     $ task 1 export
     {"id":1,"description":"Long task","estimate":1000, ...}
 

-As long as ``TaskWarrior``'s config is updated, we can approach UDAs as built in attributes::
+We can also speficy UDAs as arguments in the TaskFilter::

 
     >>> tw.tasks.filter(estimate=1000)
     Long task
 
     >>> tw.tasks.filter(estimate=1000)
     Long task


@@ -456,9 +490,16 @@ As long as ``TaskWarrior``'s config is updated, we can approach UDAs as built in
 Syncing
 -------
 
 Syncing
 -------
 

-Syncing is not directly supported by tasklib, but it can be made to work in a similiar way
-as the UDAs. First we need to update the ``config`` dictionary by the values required for
-sync to work, and then we can run the sync command using the ``execute_command()`` method::
+If you have configurated the needed config variables in your .taskrc, syncing
+is as easy as::
+
+    >>> tw = TaskWarrior()
+    >>> tw.execute_command(['sync'])
+
+If you want to use non-standard server/credentials, you'll need to provide configuration
+overrides to the ``TaskWarrior`` instance. Update the ``config`` dictionary with the
+values you desire to override, and then we can run the sync command using
+the ``execute_command()`` method::

 
     >>> tw = TaskWarrior()
     >>> sync_config = {
 
     >>> tw = TaskWarrior()
     >>> sync_config = {