Welcome to Rattail. Most developer information (API reference, etc.) should be found in the documentation set you’re currently reading, which in turn is part of Rattail’s source code.
Other documentation exists as well; please see Rattail’s home page at rattail.edbob.org for more.
The following pages attempt to form a cookbook of sorts, to promote understanding of how “stock” Rattail may be used in real life, as well as providing a quick reference guide.
Examples will often tend to assume Linux is the operating system in use, except where indicated. However the sudo command will also be “assumed” in the sense that it will typically be ommitted, again except where you see it.
For the uninitiate (read: Windows noob :), the “~” character, as in ~/src, is meant to refer to the user’s home folder.
The following pages describe the rattail Python package from a caller’s perspective.
Note that since the rattail namespace is meant to be shared by other related projects, what you have installed locally may give you a fuller namespace, e.g. by adding support for some hardware device etc. Such projects will have their own documentation in that case; the documentation here only shows what you get with “Rattail proper.”
Note also that the rattail namespace may change rather significantly after rattail.init() is called; see that function for details.
There are a handful of other Rattail packages out there.
Document the enum parameter.
(The original entry is located in rattail.rst, line 10.)