Lyntin

Some notes about documentation

API documentation is extracted from the source code using EpyDoc.

Documentation is pretty stable at this point. I roll out a new API doc every time I do a release. The README, INSTALL, and HACKING docs that come with Lyntin, while they could use some additional work, are passable.

Documentation in the wiki is updateable by everyone. Feel free to check it out (for the latest in documentation) and edit it if you find errors or pieces missing.

If you have problems with the documentation, let us know on the lyntin-devl mailing list. If ever feel the need to write new documentation or help fix existing stuff, please send fixes/new stuff to the lyntin-devl mailing list.

Documentation is date-stamped with either the generation date or the last time it was checked into CVS so you can easily tell its freshness.

In addition to documentation here, there is user contributed documentation in the form of tutorials and Lyntin modules in the Lyntin code repository.

Lyntin development documentation

Lyntin 4.1.1 documentation

  • Lyntin README -- covers why you want to use Lyntin, and some other stuff
  • Lyntin INSTALL guide -- covers installation
  • Lyntin COMMANDS reference -- covers all the commands that come with Lyntin, command syntax, and eval modes
  • Lyntin HACKING guide -- covers Lyntin's architecture and Lyntin programming
  • API docs -- complete API documentation
  • Tutorial 1: basic commands in Lyntin 4.0 -- This tutorial very slowly walks through building a basic one-command module and all the pieces involved (except argparser stuff). It assumes very little prior knowledge of module hacking in Lyntin, but does assume you know some modicum of Python.
  • Tutorial 2: using hooks in Lyntin 4.0 -- This tutorial builds upon the first tutorial by covering using hooks in Lyntin. It does this by building a basic idling module which tells you how many minutes you've been idling for. This requires the use of the from_user_hook and the timer_hook.

Lyntin 3.3 documentation

  • Lyntin README -- covers why you want to use Lyntin, and some other stuff
  • Lyntin INSTALL guide -- covers installation
  • Lyntin COMMANDS reference -- covers all the commands that come with Lyntin, command syntax, and eval modes
  • Lyntin HACKING guide -- covers Lyntin's architecture and Lyntin programming
  • Lyntin 3.3 changelog
  • Lyntin 3.3.1 changelog
  • API docs -- complete API documentation for Lyntin 3.3.
  • Tutorial 1: basic commands -- This tutorial very slowly walks through building a basic one-command module and all the pieces involved (except argparser stuff). It assumes very little prior knowledge of module hacking in Lyntin, but does assume you know some modicum of Python.
  • Tutorial 2: using hooks -- This tutorial builds upon the first tutorial by covering using hooks in Lyntin. It does this by building a basic idling module which tells you how many minutes you've been idling for. This requires the use of the from_user_hook and the timer_hook.

Off-site documentation and references

Places where Lyntin is listed

Lyntin is listed in the following directories: