Documentation
¶
Overview ¶
Package adapter groups the implementations of the app ports: upstream sources, on-demand registries, reference lists shipped with the binary, storage, and the inbound HTTP and MCP servers (ADR 0002).
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package alert tells the operator that a source could not be synced or reloaded: an error line in the log, and a JSON POST to a webhook when one is configured.
|
Package alert tells the operator that a source could not be synced or reloaded: an error line in the log, and a JSON POST to a webhook when one is configured. |
|
Package corpus reads the labelled evaluation corpus of testdata/corpus: scam.csv, inputs an authority blacklisted, and legit.csv, inputs of verified legitimate entities.
|
Package corpus reads the labelled evaluation corpus of testdata/corpus: scam.csv, inputs an authority blacklisted, and legit.csv, inputs of verified legitimate entities. |
|
reference
|
|
|
hosting
Package hosting reads the reference list of shared platforms that host their users' pages under a path of their own domain, shipped with the binary (platforms.csv, documented in docs/sources.md).
|
Package hosting reads the reference list of shared platforms that host their users' pages under a path of their own domain, shipped with the binary (platforms.csv, documented in docs/sources.md). |
|
official
Package official reads the reference list of official domains often imitated, shipped with the binary (domains.csv, documented in docs/sources.md).
|
Package official reads the reference list of official domains often imitated, shipped with the binary (domains.csv, documented in docs/sources.md). |
|
registry
|
|
|
bodacc
Package bodacc reads the notices the BODACC (DILA, Licence Ouverte; docs/sources.md) published about a company, by SIREN only: collective procedures, radiations, conciliations and professional recoveries.
|
Package bodacc reads the notices the BODACC (DILA, Licence Ouverte; docs/sources.md) published about a company, by SIREN only: collective procedures, radiations, conciliations and professional recoveries. |
|
rdap
Package rdap reads the registration date of a domain from the RDAP server of its registry (RFC 9082, RFC 9083), found through the IANA bootstrap file (RFC 9224), never through a third-party aggregator (docs/sources.md).
|
Package rdap reads the registration date of a domain from the RDAP server of its registry (RFC 9082, RFC 9083), found through the IANA bootstrap file (RFC 9224), never through a third-party aggregator (docs/sources.md). |
|
replay
Package replay records the answers of the registries and plays them back, so that the evaluation corpus is scored without the network.
|
Package replay records the answers of the registries and plays them back, so that the evaluation corpus is scored without the network. |
|
sirene
Package sirene reads a company's name, creation date and head office state from the API Recherche d'entreprises (DINUM, INSEE data, Licence Ouverte 2.0; docs/sources.md), by SIREN only.
|
Package sirene reads a company's name, creation date and head office state from the API Recherche d'entreprises (DINUM, INSEE data, Licence Ouverte 2.0; docs/sources.md), by SIREN only. |
|
source
|
|
|
acpr
Package acpr holds the connector of the blacklist the Autorité de contrôle prudentiel et de résolution and the AMF publish through Assurance Banque Épargne Info Service (docs/sources.md).
|
Package acpr holds the connector of the blacklist the Autorité de contrôle prudentiel et de résolution and the AMF publish through Assurance Banque Épargne Info Service (docs/sources.md). |
|
amf
Package amf holds the connectors of the lists the Autorité des marchés financiers publishes daily on data.gouv.fr under the Licence Ouverte 2.0 (docs/sources.md): the blacklist, and the white lists of digital asset service providers (PSAN) and of offers in goods (biens divers).
|
Package amf holds the connectors of the lists the Autorité des marchés financiers publishes daily on data.gouv.fr under the Licence Ouverte 2.0 (docs/sources.md): the blacklist, and the white lists of digital asset service providers (PSAN) and of offers in goods (biens divers). |
|
arcep
Package arcep holds the connector of the national numbering plan the Autorité de régulation des communications électroniques, des postes et de la distribution de la presse publishes under the Licence Ouverte (docs/sources.md): the ranges of phone numbers it has assigned (MAJNUM), joined with the name and SIREN of the operator each range is assigned to (identifiants_CE).
|
Package arcep holds the connector of the national numbering plan the Autorité de régulation des communications électroniques, des postes et de la distribution de la presse publishes under the Licence Ouverte (docs/sources.md): the ranges of phone numbers it has assigned (MAJNUM), joined with the name and SIREN of the operator each range is assigned to (identifiants_CE). |
|
catalog
Package catalog lists the sources Arnakoff syncs, how often, and the hosts they reach: the one list the sync and API processes are built from.
|
Package catalog lists the sources Arnakoff syncs, how often, and the hosts they reach: the one list the sync and API processes are built from. |
|
listing
Package listing turns the entries of the published lists into the keys their snapshot rows are looked up by: a site's normalised host and path, an address, an E.164 phone number or a SIREN, normalised by the domain value objects.
|
Package listing turns the entries of the published lists into the keys their snapshot rows are looked up by: a site's normalised host and path, an address, an E.164 phone number or a SIREN, normalised by the domain value objects. |
|
Package store keeps the last valid snapshot of each source on disk, shared by the sync and API processes and kept across restarts.
|
Package store keeps the last valid snapshot of each source on disk, shared by the sync and API processes and kept across restarts. |
Click to show internal directories.
Click to hide internal directories.