Extensions

Actors management

An actor in the UML “specifies a role played by a user or any other system that interacts with the subject”. In OrgTool this concept is used to represent people, organizations, stakeholders, etc.

Contacts

class orgtool.ext.contacts.ContactsCLI(app, conf)

A stripped-down CLI-only contacts management plugin.

class orgtool.ext.contacts.ContactsWeb(app, conf)

A CLI- and web-enabled contacts management plugin. Integrates with WebAdmin.

Bookmarks: del.icio.us

Integration with delicious.com.

Events

This extension provides one of the most important schemata in the OrgTool ecosystem. Event is the core model for messages, payments, etc.

orgtool.ext.events.event_extension(app, conf)

Provides a simple CLI for event management.

Finances

class orgtool.ext.finances.WebMoneyTracker(app, conf)

Money tracker: web interface.

Mobile phones (Gammu)

Incremental importing of the SMS archive from a mobile phone using python-gammu.

Configuration

Settings example (in YAML):

extensions:
    orgtool.ext.mobile.MobileETL:
        my_number: "+1234567890"

Note

The phone does not store sender and receiver numbers in the message; instead, it stores only the number from which the message was received or to which it was sent. Unfortunately we cannot get or restore “our” number. You must specify it explicitly in settings (as in the example above).

Note

It seems that Gammu returns incorrect folder names. Moreover, this could not be fixed because the exact order seems to depend on the phone model. We just omit the folder.

Commands

This extension provides following commands within namespace “mobile”:

• import-sms
• import-contacts
• import-plans

API reference

orgtool.ext.mobile.setup(app, conf)

Tool extension for importing data from mobile phones.

Needs management

class orgtool.ext.needs.NeedsCLI(app, conf)

A stripped-down lightweight needs management plugin (CLI only)

class orgtool.ext.needs.NeedsPlugin(app, conf)

The basic full-blown plugin for needs management.

Notes

class orgtool.ext.notes.NotesPlugin(app, conf)

Web interface.

Document management system

This extension is a basic implementation of DMS. It features:

• a command-line interface for adding scanned papers (including batch processing with OCR and custom metadata);
• web interface for search and retrieval (with thumbnails and OCR results).

The extension aims to provide the following capabilities:

• Metadata:
  • summary (entered manually or automatically fetched from filename);
  • date and time of storage;
  • source file fingerprint (so the same file will not be imported twice).
• Integration: the data is stored in a document-oriented database within the OrgTool ecosystem, so it is pretty easy to reference the scanned papers from other types of documents or even merge them.
• Capture: the system allows batch import of scanned papers (images) with OCR processing on the fly. Direct scanning is also supported.
• Indexing: see “Searching” and “Retrieval” below. Pages are organized in “papers” (one or more pages) and pages can be organized by topic or linked to other objects.
• Storage: the scanned papers (images) are bound to database records (documents) and stored in the file system. The application manages the coupling.
• Retrieval: currently rather simple: by key, full-text search, categorization. See also: document retrieval.
• Distribution: not yet (see “Publishing” below).
• Security: its up to you. No need to store private data anywhere outside of your PC (unless you need to).
• Workflow: not yet (and unsure if it belongs to this library at all).
• Collaboration: not yet (this is rather a home system as of now).
• Versioning: not yet.
• Searching: the documents can be searched by summary or by details. Note that details are usually extracted automatically from the image via OCR.
• Publishing: not yet. Export to PDF may be added later (with pages automatically glued into a single document).
• Reproduction: the images are stored as is and can be printed out.

API reference

class orgtool.ext.papers.PapersCLI(app, conf)

Storage for scanned documents with integrated OCR support.

Example configuration (YAML):

devel_papers.Papers:
    # this is where the files will be actually stored
    # (do not add/rename/move/delete them there manually!):
    image_base_path: /home/johndoe/images/scanned_papers/

Note

This extension uses CuneiForm for optical character recignition. It is optional but should be installed in order to enable OCR.

Talks

Communication tracker.

class orgtool.ext.talks.TalksPlugin(app, conf)

Web interface.

Time tracking

class orgtool.ext.time.TimeCLI(app, conf)

A stripped-down lightweight time tracking plugin (CLI only)

Object tracking

This extension provides a common API for tracking objects in the database. It does not expose a user interface.