Stalker

=====

* **Update:** Vacation tjp template now includes the time values of the start
and end dates of the Vacation instance.

=========

* **Update:** For a container task, ``Task.total_logged_seconds`` and
``Task.schedule_seconds`` attributes are now using the info of the child
tasks. Also these attributes are cached to database, so instead of querying
the child tasks all the time, the calculated data is cached and whenever a
TimeLog is created or updated for a child task (which changes the
``total_logged_seconds`` for the child task) or the ``schedule_timing`` or
``schedule_unit`` attributes are updated, the cached values are updated on
the parents. Allowing Stalker to display percent_complete info of a container
task without loading any of its children.

* **New:** Added ``Task.percent_complete`` attribute, which calculates the
percent of completeness of the task based on the
``Task.total_logged_seconds`` and ``Task.schedule_seconds`` attributes.

* **Fix:** Added ``TimeLog.__eq__()`` operator to more robustly check if the
time logs are overlapping.

* **New:** Added ``Project.percent_complete``,
``Percent.total_logged_seconds`` and ``Project.schedule_seconds`` attributes.

* **Update:** ``ScheduleMixin._validate_dates()`` does not set the date values
anymore, it just return the calculated and validated ``start``, ``end`` and
``duration`` values.

* **Update:** ``Vacation`` now can be created without a ``User`` instance,
effectively making the ``Vacation`` a ``Studio`` wide vacation, which applies
to all users.

* **Update:** ``Vacation.__strictly_typed__`` is updated to ``False``, so there
is no need to create a ``Type`` instance to be able to create a ``Vacation``.

* **New:** ``Studio.vacations`` property now returns the ``Vacation`` instances
which has no *user*.

* **Update:** ``Task.start`` and ``Task.end`` values are no more read from
children Tasks for a container task over and over again but calculated
whenever the start and end values of a child task are changed or a new child
is appended or removed.

* **Update:** ``SimpleEntity.description`` validation routine doesn't convert
the input to string anymore, but checks the given description value against
being a string or unicode instance.

* **New:** Added ``Ticket.summary`` field.

* **Fix:** Fixed ``Link.extension``, it is now accepting unicode.

=========

* **New:** Added a new attribute to ``Version`` class called
``latest_version`` which holds the latest version in the version queue.

* **New:** To optimize the database connection times, ``stalker.db.setup()``
will not try to initialize the database every time it is called anymore. This
leads a ~4x speed up in database connection setup. To initialize a newly
created database please use::

for a newly created database
from stalker import db
db.setup() connects to database
db.init() fills some default values to be used with Stalker

for any subsequent access just use (don't need to call db.init())
db.setup()

* **Update:** Removed all ``__init_on_load()`` methods from all of the classes.
It was causing SQLAlchemy to eagerly load relations, thus slowing down
queries in certain cases (especially in ``Task.parent`` -> ``Task.children``
relation).

* **Fix:** Fixed ``Vacation`` class tj3 format.

* **Fix:** ``Studio.now`` attribute was not properly working when the
``Studio`` instance has been restored from database.

=========

* **New:** Added a new attribute to ``Task`` class called ``responsible``.

* **Update:** Removed ``Sequence.lead_id`` use ``Task.reponsible`` instead.

* **Update:** Updated documentation to include documentation about
Configuring Stalker with ``config.py``.

* **Update:** The ``duration`` argument in ``Task`` class is removed. It is
somehow against the idea of having ``schedule_model`` and ``schedule_timing``
arguments (``schedule_model='duration'`` is kind of the same).

* **Update:** Updated ``Task`` class documentation.

=========

* **New:** Added ``Version.created_with`` attribute to track the environment or
host program name that a particular ``Version`` instance is created with.

=========

* **Update:** Moved the Pyramid part of the system to another package called
``stalker_pyramid``.

* **Fix:** Fixed ``setup.py`` where importing ``stalker`` to get the
``__version__`` variable causing problems.