Directives¶

Configurations¶

The following configuration options are available :

osint_emit_warnings = False
osint_emit_nodes_warnings = False
osint_emit_related_warnings = False
osint_default_cats = None
osint_country_cats = None
osint_org_cats = None
osint_ident_cats = None
osint_event_cats = None
osint_relation_cats = None
osint_link_cats = None
osint_quote_cats = None
osint_source_cats = None
osint_country = None
osint_csv_store = csv_store
osint_local_store = local_store
osint_xref_text = sdescription
osint_extsrc_text = sdescription
osint_extsrc_extended = True
osint_auths = []

osint_auths : a list of (domain, user, password, apikey)

Look at cats.

Indexes¶

The following indexes are available :

links : Links Index
relations : Relations Index
idents : Idents Index
countries : Countries Index
osint : OSInt Index
events : Events Index
quotes : Quotes Index
sources : Sources Index
orgs : Orgs Index
related : Related Index

Roles¶

The following roles are available :

extsrc : Create an http link using the label to the first source of the item.

        :osint:extsrc:`ident.testid`
        :osint:extsrc:`External link <ident.testid>`
        :osint:extsrc:`External link - <<event.testev>>`
        :osint:extsrc:`event.testev`
        ...
    
exturl : Create an http link using the url as a label to the first source of the item.

        :osint:exturl:`ident.testid`
        :osint:exturl:`External link <ident.testid>`
        :osint:exturl:`External link - <<event.testev>>`
        :osint:exturl:`event.testev`
        ...
    
ref : Create internal reference to items in quest.

        :osint:ref:`ident.testid`
        :osint:ref:`External link <ident.testid>`
        :osint:ref:`event.testev`
        ...

Script¶

The following scripts are available :

Usage: osint_quest [OPTIONS] COMMAND [ARGS]...

  Command group.

Options:
  --docdir TEXT         The documentation dir (where is the Makfile or
                        make.bat)
  --debug / --no-debug
  --help                Show this message and exit.

Commands:
  cat        List all objects in quest with cat
  cats       List all cats in quest
  dump       Dump data of a dict obj
  integrity  Check integrity of the quest : duplicates, orphans, ...

Directive event¶

Represent an event : ie a meeting, an article, a manifestation, …

You can create a Link to an Event from an Ident.

class : class_option
source : unchanged
sources : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
from : unchanged_required
from-label : unchanged_required
from-begin : unchanged_required
from-end : unchanged_required
to : unchanged_required
to-label : unchanged_required
to-begin : unchanged_required
to-end : unchanged_required
begin : unchanged_required
end : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

Directive ident¶

Represent an ident : ie a person, company, …

You can create a Relation from an Ident to an Ident.

You can create a Link from an Ident to an Event.

An ident can belong to one or many orgs.

class : class_option
source : unchanged
sources : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
from : unchanged_required
from-label : unchanged_required
from-begin : unchanged_required
from-end : unchanged_required
to : unchanged_required
to-label : unchanged_required
to-begin : unchanged_required
to-end : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

    An ident entry, displayed (if configured) in the form of an admonition.

Directive link¶

Represent a link from an Ident to an Event.

class : class_option
sources : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
from : unchanged_required
begin : unchanged_required
end : unchanged_required
to : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

    A link entry, displayed (if configured) in the form of an admonition.

Directive org¶

Represent an organisation used in idents.

Use :ident: to automatically create an ident.

class : class_option
ident : unchanged
source : unchanged
sources : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

    A org entry, displayed (if configured) in the form of an admonition.

Directive country¶

Represent a country.

class : class_option
ident : unchanged
source : unchanged
sources : unchanged
cats : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required

    A country entry, displayed (if configured) in the form of an admonition.

Directive quote¶

Represent a quote from an Event to an Event.

class : class_option
sources : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
from : unchanged_required
to : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged

    A quote entry, displayed (if configured) in the form of an admonition.

Directive relation¶

Represent a relation from an Ident to an Ident.

class : class_option
source : unchanged
sources : unchanged
label : unchanged
description : unchanged_required
short : unchanged_required
from : unchanged_required
begin : unchanged_required
end : unchanged_required
to : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required
style : unchanged_required
shape : unchanged

    A relation entry, displayed (if configured) in the form of an admonition.

Directive source¶

Represent a source. They are used for analyse, …

A source can automatically created from an ident, event, … using the :source: and :link: (or other)

class : class_option
label : unchanged
description : unchanged_required
short : unchanged_required
cats : unchanged_required
orgs : unchanged_required
idents : unchanged_required
country : unchanged_required
style : unchanged_required
shape : unchanged
url : unchanged_required
youtube : unchanged_required
bsky : unchanged_required
link : unchanged_required
local : unchanged
scrap : unchanged_required

    A source entry, displayed (if configured) in the form of an admonition.

url vs link vs local vs youtube vs bsky¶

url : an http link that will be download for pdf and text processing.
link : an http link that will be only be reported. No download at all.
local : the full filename
youtube : the url to a youtube video, the video will be downloaded (if enabled) and the subtitles will be downloaded and translates (if enabled)
bksy : the url of a bsky post, the post and the following ones from the same user will be downloaded (if enabled)

Directive csv¶

Filter data using orgs, cats and countries ang create csv to download.

class : class_option
caption : unchanged
cats : unchanged_required
orgs : unchanged_required
countries : unchanged_required
borders : yesno
with-json : yesno
with-archive : yesno
label : unchanged
description : unchanged_required
short : unchanged_required
idents : unchanged_required

    An OSInt csv.

Directive graph¶

Filter data using orgs, cats and countries ang create a graph.

For colors, shapes, and styles, update different cats in conf.py by consulting the graphviz documentation :

shapes

styles

colors

class : class_option
alt : unchanged
caption : unchanged
borders : yesno
width : positive_int
height : positive_int
link-report : yesno
label : unchanged
description : unchanged_required
short : unchanged_required
cats : unchanged_required
idents : unchanged_required
orgs : unchanged_required
countries : unchanged_required

    An OSInt graph.

Directive report¶

Filter data using orgs, cats and countries ang create report in table.

class : class_option
caption : unchanged
borders : yesno
label : unchanged
description : unchanged_required
short : unchanged_required
cats : unchanged_required
idents : unchanged_required
orgs : unchanged_required
countries : unchanged_required

    An OSInt report.

Directive sourcelist¶

Filter data using orgs, cats and countries ang create list of sources in table.

class : class_option
caption : unchanged
borders : yesno
label : unchanged
description : unchanged_required
short : unchanged_required
cats : unchanged_required
idents : unchanged_required
orgs : unchanged_required
countries : unchanged_required

    An OSInt sources list.

Directive eventlist¶

Filter data using orgs, cats and countries ang create list of events in table.

class : class_option
caption : unchanged
borders : yesno
with-id : yesno
with-url : yesno
label : unchanged
description : unchanged_required
short : unchanged_required
cats : unchanged_required
idents : unchanged_required
orgs : unchanged_required
countries : unchanged_required

    An OSInt events list.

Cats¶

Categories are used to filter and represent data in graphs.

You can configure them with the following values in conf.py. If a value is None, the osint_default_cats is used.

osint_default_cats
osint_country_cats
osint_org_cats
osint_ident_cats
osint_event_cats
osint_relation_cats
osint_link_cats
osint_quote_cats
osint_source_cats

Here is a sample :

osint_default_cats = {
        'media' : {
            'shape' : 'egg',
            'style' : 'solid',
            'color' : 'blue',
        },
        'financial' : {
            'shape' : 'hexagon',
            'style' : 'solid',
        'fillcolor' : 'red',
        },
        'other' : {
            'shape' : 'octogon',
            'style' : 'dashed',
        },
    }

Graph are created using graphviz.

You can find more shapes, styles and colors in their documentation.