Package: saturnin
saturninTheFirebird Butlerplatform for PythonSaturnin is an implementation of Firebird Butler platform for Python.NoteFor best experience with Saturnin console and other tools, we recommend to use terminal with good support for ANSI escape sequences. On Windows platform, we recommend to useWindows Terminal.Table of ContentsLicenseInstallationInitializationSaturnin consoleInstalling servicesUsing Firebird servicesSaturnin recipesDocumentationLicensesaturninis distributed under the terms of theMITlicense.InstallationRequires: Firebird 3.8+For regular deployments, we recommend installing using thepipxtool, which installs into a separate virtual Python environment and exposes all executable
commands in the search path.pip install pipxpipx install saturninIf you want to develop your own services using the Saturnin SDK, we recommend that you
first create a separate virtual environment into which you install Saturnin in the usual
way. For example:pip install saturninInitializationSaturnin uses a number of files and directories whose location in the file system corresponds
to the standards for the platform on which it is installed. This basic directory placement
scheme can be changed by using theSATURNIN_HOMEenvironment variable, which sets the root
of the other directory locations. Alternatively, you can create a"home"subdirectory in
the root directory of the virtual environment in which Saturnin is isolated.WarningBecause on Linux or MacOS the default location of some directories may require higher than
normal access rights, we recommend that you always use the home directory setting on these
platforms.NoteTo set the home directory in the virtual environment (recommended when installing with pipx),
use the command:saturnin create homeThe next step is to initialize the Saturnin installation with the command:saturnin initializeSaturnin consoleThesaturnintool is used to manage the Saturnin platform installation. It can be operated
in two modes:Single command (direct) mode.The required command and parameters are entered directly on
the command line, and after the command is executed, the tool is terminated.Interactive console modeactivated by running the tool without additional parameters.
The interactive console offers an enhanced command line with persistent command history,
command and parameter completion, and interactive help.NoteThe command set available in console mode differs from command set available in direct mode,
as some commands (typically those required to run only once or not very often likeinitializeorcreate home) are available only in direct mode.For normal work, we recommend using the interactive console mode. In the following sections,
all the commands described are entered in the interactive console.Installing servicesImmediately after installation, Saturnin does not provide any Butler services. These
services need to be installed separately. Although you can install service packages with
the standard pip utility, we recommend that you use saturnin'sinstall package,uninstall package, andpipcommands to install, uninstall, or manage service packages,
as these commands also update the necessary registries that Saturnin uses to work with
Butler services and Saturnin applications.NoteIf necessary, the command:update registrycan be used to update the registries.To install package with Saturnin core services, use command:install package saturnin-coreUsing Firebird servicesTo use Butler services that work with Firebird server, you need to create (and update)
a configuration file for the firebird driver using the commands:create config firebirdedit config firebirdSaturnin recipesRecipes are Saturnin-specific configuration files with instructions for running Butler
services built for Saturnin. Recipes can be created with thecreate recipecommand, which
creates a recipe template that typically needs to be modified further (because it only
contains default values). Recipes created independently (e.g. by a solution supplier or
provided by installed Saturnin application) must be installed with theinstall recipecommand.Created or installed recipes can be run with therun recipe-namecommand. You can get
a list of recipes that can be started with thelist recipescommand.For more information, see theUsage Guide.DocumentationDocumentation related to Saturnin:Firebird ButlerSaturninSaturnin COREservicesSaturnin SDK