Difference between revisions of "Python"
Jump to navigation
Jump to search
| Line 54: | Line 54: | ||
* [[TruxtonCommunication]] - For adding email, sms, mms, etc. communications to Truxton. | * [[TruxtonCommunication]] - For adding email, sms, mms, etc. communications to Truxton. | ||
* [[TruxtonETL]] - For becoming a Truxton [https://en.wikipedia.org/wiki/Extract,_transform,_load ETL] process. | * [[TruxtonETL]] - For becoming a Truxton [https://en.wikipedia.org/wiki/Extract,_transform,_load ETL] process. | ||
| − | * [[TruxtonEvent]] - For adding records to the [[Event Table | Event table. | + | * [[TruxtonEvent]] - For adding records to the <code><nowiki>[</nowiki>[[Event Table|Event]]<nowiki>]</nowiki></code> table. |
* [[TruxtonEventType]] - For adding custom event types to Truxton. | * [[TruxtonEventType]] - For adding custom event types to Truxton. | ||
| − | * [[TruxtonEXIF]] - For adding records to the [[EXIF Table | EXIF table. | + | * [[TruxtonEXIF]] - For adding records to the <code><nowiki>[</nowiki>[[EXIF Table|EXIF]]<nowiki>]</nowiki></code> table. |
* [[TruxtonFileIO]] - For working with a read-only file stored in Truxton. | * [[TruxtonFileIO]] - For working with a read-only file stored in Truxton. | ||
* [[TruxtonFileType]] - For adding new file types to Truxton. | * [[TruxtonFileType]] - For adding new file types to Truxton. | ||
* [[TruxtonInvestigation]] - For creating new investigations in Truxton. | * [[TruxtonInvestigation]] - For creating new investigations in Truxton. | ||
| − | * [[TruxtonJurisdiction]] - For creating new | + | * [[TruxtonJurisdiction]] - For creating new jurisdictions in Truxton. |
* [[TruxtonLocation]] - For adding geographic coordinates to the [[Location Table | Location table.]] | * [[TruxtonLocation]] - For adding geographic coordinates to the [[Location Table | Location table.]] | ||
* [[TruxtonMedia]] - For adding media to Truxton. | * [[TruxtonMedia]] - For adding media to Truxton. | ||
| Line 66: | Line 66: | ||
* [[TruxtonObject]] - The object responsible for a connection to Truxton. | * [[TruxtonObject]] - The object responsible for a connection to Truxton. | ||
* [[TruxtonOptions]] - The object responsible for retrieving configuration variables. | * [[TruxtonOptions]] - The object responsible for retrieving configuration variables. | ||
| − | * [[TruxtonRelation]] - For adding records to the [[Relation Table | Relation | + | * [[TruxtonRelation]] - For adding records to the <code><nowiki>[</nowiki>[[Relation Table|Relation]]<nowiki>]</nowiki></code> table for relating two items in Truxton. |
* [[TruxtonSubject]] - For adding subjects of investigations, aka persons of interest, aka suspects. | * [[TruxtonSubject]] - For adding subjects of investigations, aka persons of interest, aka suspects. | ||
| − | * [[TruxtonUrl]] - For adding records to the [[WebsiteVisit Table | WebsiteVisit table. | + | * [[TruxtonUrl]] - For adding records to the <code><nowiki>[</nowiki>[[WebsiteVisit Table|WebsiteVisit]]<nowiki>]</nowiki></code> table. |
| − | * [[TruxtonUSB]] - For adding records to the [[USBDevice Table | USBDevice table. | + | * [[TruxtonUSB]] - For adding records to the <code><nowiki>[</nowiki>[[USBDevice Table|USBDevice]]<nowiki>]</nowiki></code> table. |
=Remarks= | =Remarks= | ||
Revision as of 16:55, 30 November 2020
Truxton supports Python 3.8 via the Truxton.pyd library.
Contents
Overview
You must use the "import" directive to load this.
Go to the C:\Program Files\Truxton\SDK folder and start Python.
import truxton
When you import truxton you will get all of the predefined constants for file type, data type, origins, locations,
messages, entities, relations, events, media, objects, url methods, and urls.
You can see them all by issuing a dir command.
>>> dir(truxton)
This will allow your Python code to use the same constant names as C, C++ and C# code.
>>> print(truxton.Type_JPEG)
203
Once you have this working, you can start playing with Truxton.
import truxton
def main():
t = truxton.create()
print(t.version)
if __name__ == "__main__":
main()
You can create a folder for your project, copy the SDK contents into it and work from there.
Style
In general, when using a Truxton Python object, you will follow this pattern:
- Create the object
- Set the data members of the object
- Call
save()to store the object in the Truxton database.
Until you call save(), nothing will appear in Truxton.
Classes
Truxton exposes several classes to Python.
- Truxton - The top level object.
- TruxtonArtifact - For adding records to the
[Entity]table. - TruxtonChildFileIO - For writing a file to Truxton.
- TruxtonCommunication - For adding email, sms, mms, etc. communications to Truxton.
- TruxtonETL - For becoming a Truxton ETL process.
- TruxtonEvent - For adding records to the
[Event]table. - TruxtonEventType - For adding custom event types to Truxton.
- TruxtonEXIF - For adding records to the
[EXIF]table. - TruxtonFileIO - For working with a read-only file stored in Truxton.
- TruxtonFileType - For adding new file types to Truxton.
- TruxtonInvestigation - For creating new investigations in Truxton.
- TruxtonJurisdiction - For creating new jurisdictions in Truxton.
- TruxtonLocation - For adding geographic coordinates to the Location table.
- TruxtonMedia - For adding media to Truxton.
- TruxtonMessage - The way Truxton ETL processes communicate.
- TruxtonObject - The object responsible for a connection to Truxton.
- TruxtonOptions - The object responsible for retrieving configuration variables.
- TruxtonRelation - For adding records to the
[Relation]table for relating two items in Truxton. - TruxtonSubject - For adding subjects of investigations, aka persons of interest, aka suspects.
- TruxtonUrl - For adding records to the
[WebsiteVisit]table. - TruxtonUSB - For adding records to the
[USBDevice]table.
Remarks
The Python API is designed primarily for programs to contribute to Truxton.
Truxton.pyd was developed using the C API with a thin adapter layer of code to translate from Python provider semantics to Truxton calls.
