script
The script command executes a Python 3.11.5 script that uses the RaptorXML Python API.
raptorxmlxbrl script [options] PythonScriptFile |
The File argument is the path to the Python script you want to execute. Additional options are available for this command. To obtain a list of these options, run the following command:
raptorxmlxbrl script [-h | --help] |
Examples
•raptorxmlxbrl script c:\MyPythonScript.py
•raptorxmlxbrl script -h
•raptorxmlxbrl script # Without a script file, an interactive Python shell is started
•raptorxmlxbrl script -m pip # Loads and executes the pip module; see the Options section below
RaptorXMLXBRL (and RaptorXMLXBRLServer for administration commands) on Windows raptorxmlxbrl (and raptorxmlxbrlserver for administration commands) on Windows and Unix (Linux, Mac)
* Note that lowercase (raptorxmlxbrl and raptorxmlxbrlserver) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXMLXBRL) works only on Windows and Mac. * Use forward slashes on Linux and Mac, backslashes on Windows.
|
On Windows systems: When spaces or special characters occur in strings (for example in file or folder names, or company, person or product names), use quotes: for example, "My File". Note, however, that a backslash followed by a double-quotation mark (for example, "C:\My directory\") might not be read correctly. This is because the backslash character is also used to indicate the start of an escape sequence, and the escape sequence \" stands for the double-quotation mark character. If you want to escape this sequence of characters, use a preceding backslash, like this: \\". To summarize: If you need to write a file path that contains spaces or an end backslash, write it like this: "C:\My Directory\\".
|
Options
Any options and arguments after the script command are forwarded directly to the Python interpreter. Please consult the Python documentation page https://docs.python.org/3.11/using/cmdline.html for a complete listing of available options.