chandler2/README.txt at master · owenmorris/chandler2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
===========================================
 The New Chandler Project (rearchitecture)
===========================================

Chandler is a PIM, with support for notes, reminders, events, and the concept of
:mod:`~chandler.triage`.

Chandler is also a platform for building a PIM.  Chandler aims to
allow application builders to build different PIMs by reusing
different pieces of Chandler.

Core Chandler Sub-Projects
==========================

Chandler-Platform
-----------------

The basic unit of data in Chandler is an Item.  The Platform project
provides tools for building applications that create and extend Items.

.. toctree::
   :maxdepth: 2

   Chandler-Platform/README


Chandler-App
------------

Chandler application-specific code.

XXX This is a catch-all project for now; as it grows we will likely
    split it into separate projects, perhaps e.g.  Chandler-PIM,
    Chandler-wx, etc.

.. toctree::
   :maxdepth: 3

   Chandler-App/README

Sharing
-------

Sharing doctests are more focused on testing and less on being
instructive, so they're separated out from the main Chandler-Platform
and Chandler-App documents.

.. toctree::
   :maxdepth: 2

   Chandler-Platform/EIM
   Chandler-App/Sharing
   Chandler-App/Translator


Chandler-Development
--------------------

Tools for developing and debugging Chandler. For the moment, this
containts a PyShell window you can use for debugging.

.. toctree::
   :maxdepth: 3

   Chandler-Development/README

Hooks
=====

Because Chandler makes extensive use of entry points, any entry points
used should be documented in Hooks.txt.

.. toctree::
   :maxdepth: 1

   Hooks

Testing
=======

Each Chandler Sub-Project should have a README.txt, a collection of
test_*.py tests, and a test_suite.py which runs all tests and doctests
all .txt files.