followthemoney 1.3.7__py3-none-any.whl → 3.8.0__py3-none-any.whl

followthemoney/schema/Position.yaml

@@ -0,0 +1,50 @@
+Position:
+  label: "Position"
+  plural: "Positions"
+  extends:
+    - Thing
+  matchable: true
+  # cf. https://www.popoloproject.com/specs/post.html
+  description: >
+    A post, role or position within an organization or body.
+    This describes a position one or more people may occupy
+    and not the occupation of the post by a specific individual at a
+    specific point in time.
+
+    'subnationalArea' should be used to further restrict the scope of the
+    position. It should not simply represent some regional aspect of the
+    role - e.g. the constituency of a national member of parliament - when
+    their legislative jurisdiction is nationwide.
+  featured:
+    - name
+    - country
+    - subnationalArea
+  caption:
+    - name
+  required:
+    - name
+  temporalExtent:
+    start:
+      - inceptionDate
+    end:
+      - dissolutionDate
+  properties:
+    organization:
+      label: "Organization"
+      type: entity
+      reverse:
+        name: positions
+        label: Positions
+      range: Organization
+    inceptionDate:
+      label: Inception date
+      type: date
+    dissolutionDate:
+      label: Dissolution date
+      type: date
+    subnationalArea:
+      label: Subnational jurisdiction name or code
+      type: string
+    numberOfSeats:
+      label: Total number of seats
+      type: number

followthemoney/schema/Post.yaml

@@ -0,0 +1,42 @@
+Post:
+  label: "Post"
+  plural: "Posts"
+  extends:
+    - Interest
+  matchable: false
+  deprecated: true
+  # cf. https://www.popoloproject.com/specs/post.html
+  # But they're using it to define the post as an abstract thing, this
+  # describes the interval in which it is held by an individual.
+  description: >
+    A post, role or position held by an individual within an organization
+    or body. This describes the period for which the position is held,
+    not the abstract concept of the post.
+  featured:
+    - holder
+    - organization
+    - role
+    - startDate
+    - endDate
+  required:
+    - holder
+  caption:
+    - summary
+    - organization
+    - role
+  properties:
+    holder:
+      label: "Holder"
+      reverse:
+        name: posts
+        label: "Posts held"
+      type: entity
+      range: Person
+    organization:
+      # This is a stub text version of the org, describing it by name.
+      label: "Organization"
+      type: string
+    wikidataId:
+      label: "Wikidata ID"
+      hidden: true
+      type: identifier

followthemoney/schema/Project.yaml

@@ -0,0 +1,27 @@
+Project:
+  label: Project
+  plural: Projects
+  extends:
+    - Interval
+    - Thing
+    - Value
+  description: >
+    An activity carried out by a group of participants.
+  matchable: false
+  featured:
+    - name
+    - projectId
+    - startDate
+  caption:
+    - name
+    - projectId
+  properties:
+    projectId:
+      label: "Project ID"
+      type: identifier
+    status:
+      label: "Status"
+    phase:
+      label: "Phase"
+    goal:
+      label: "Project goal"

followthemoney/schema/ProjectParticipant.yaml

@@ -0,0 +1,36 @@
+ProjectParticipant:
+  label: Project participant
+  plural: Project participants
+  extends:
+    - Interest
+  description: >
+    An activity carried out by a group of participants.
+  matchable: false
+  featured:
+    - project
+    - participant
+    - role
+  caption:
+    - role
+  edge:
+    source: participant
+    label: "participates in"
+    target: project
+    directed: true
+    caption:
+      - role
+  properties:
+    project:
+      label: "Project"
+      type: entity
+      range: Project
+      reverse:
+        name: participants
+        label: "Participants"
+    participant:
+      label: "Participant"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: projectParticipation
+        label: "Projects"

followthemoney/schema/PublicBody.yaml

@@ -1,6 +1,17 @@
 PublicBody:
   label: Public body
   plural: Public bodies
-  icon: fa-building
-  extends: Organization
-  matchable: true
+  description: >
+    A public body, such as a ministry, department or state company.
+  extends:
+    - Organization
+  matchable: true
+  featured:
+    - name
+    - country
+    - legalForm
+    - status
+  caption:
+    - name
+  required:
+    - name

followthemoney/schema/RealEstate.yaml

@@ -1,18 +1,25 @@
 RealEstate:
+  extends:
+    - Asset
   label: Real estate
   plural: Real estates
-  extends: Asset
-  icon: fa-map
+  description: "A piece of land or property."
   matchable: false
   featured:
     - registrationNumber
     - address
     - country
+  caption:
+    - name
+    - address
+    - registrationNumber
   properties:
     latitude:
       label: Latitude
+      type: number
     longitude:
       label: Longitude
+      type: number
     censusBlock:
       label: Census block
     cadastralCode:
@@ -20,6 +27,7 @@ RealEstate:
       type: identifier
     area:
       label: Area
+      type: number
     registrationNumber:
       label: Registration number
       type: identifier
@@ -40,4 +48,12 @@ RealEstate:
       label: Land type
     createDate:
       label: Record date
-      type: date
+      type: date
+    parent:
+      label: "Parent unit"
+      description: "If this entity is a subunit, another entity (real estate) is its parent"
+      reverse:
+        label: "Subunits"
+        name: subunits
+      type: entity
+      range: RealEstate

followthemoney/schema/Representation.yaml

@@ -1,25 +1,36 @@
 Representation:
   label: "Representation"
+  plural: "Representations"
   description: "A mediatory, intermediary, middleman, or broker acting on behalf of a legal entity."
-  extends: Interest
-  icon: fa-rocket
+  extends:
+    - Interest
   matchable: false
   featured:
     - agent
     - client
     - role
+  required:
+    - agent
+    - client
+  edge: # AGENT represents CLIENT
+    source: agent
+    label: "represents"
+    target: client
+    directed: true
+    caption:
+      - role
   properties:
     agent: # aka representative / incorporation agent
       label: "Agent"
       type: entity
-      schema: LegalEntity
+      range: LegalEntity
       reverse:
         name: agencyClient
-        label: "Agency clients"
+        label: "Clients"
     client:
       label: "Client"
       type: entity
-      schema: LegalEntity
+      range: LegalEntity
       reverse:
         name: agentRepresentation
-        label: "Agents"
+        label: "Agents"

followthemoney/schema/Sanction.yaml

@@ -1,36 +1,60 @@
 Sanction:
   label: Sanction
   plural: Sanctions
-  extends: Interval
-  icon: fa-ban
+  description: "A sanction designation"
+  extends:
+    - Interval
   matchable: false
   featured:
     - entity
     - authority
+    - program
     - startDate
     - endDate
+  required:
+    - entity
+  caption:
+    - program
   properties:
     entity:
-      label: "Sanctioned entity"
+      label: "Entity"
       reverse:
-        name: sanctionEntity
+        name: sanctions
         label: "Sanctions"
       type: entity
-      schema: Thing
+      range: Thing
     authority:
-      label: "Sanctioning authority"
-      reverse:
-        name: sanctionAuthority
-        label: "Sanctioned entities"
-      type: entity
-      schema: Thing
+      label: "Authority"
+    authorityId:
+      label: "Authority-issued identifier"
+      type: identifier
+    unscId:
+      label: "UN SC identifier"
+      type: identifier
+      maxLength: 16
     program:
-      label: "Sanctions program"
-    sanctionStatus:
-      label: "Sanction status"
-    sanctionDuration:
-      label: "Sanction duration"
-    sanctionReason:
-      label: "Sanction reason"
-    sanctionOccurrence:
-      label: "Sanction occurrence"
+      label: "Program"
+    programId:
+      # This is a unique identifier for the program issued by OpenSanctions, but
+      # could also be used for authority-issued IDs in other usage scenarios.
+      label: "Program ID"
+      type: identifier
+      maxLength: 64
+    programUrl:
+      label: "Program URL"
+      type: url
+    provisions:
+      label: "Scope of sanctions"
+    status:
+      label: "Status"
+    duration:
+      label: "Duration"
+    reason:
+      label: "Reason"
+      type: text
+    country:
+      label: "Country"
+      type: country
+    listingDate:
+      label: "Listing date"
+      type: date

followthemoney/schema/Security.yaml

@@ -0,0 +1,59 @@
+Security:
+  extends:
+    - Asset
+  label: Security
+  plural: Securities
+  description: "A tradeable financial asset."
+  matchable: true
+  featured:
+    - isin
+    - name
+    - issuer
+    - country
+  caption:
+    - name
+    - isin
+    - registrationNumber
+  temporalExtent:
+    start:
+      - issueDate
+    end:
+      - maturityDate
+  properties:
+    isin:
+      label: ISIN
+      description: International Securities Identification Number
+      type: identifier
+      format: isin
+      maxLength: 16
+    registrationNumber:
+      label: Registration number
+      type: identifier
+    ticker:
+      label: Stock ticker symbol
+      type: identifier
+    figiCode:
+      label: Financial Instrument Global Identifier
+      type: identifier
+      format: figi
+      maxLength: 16
+    issuer:
+      label: "Issuer"
+      type: entity
+      range: LegalEntity
+      # FIXME: Should this be `Organization`?
+      reverse:
+        label: "Issued securities"
+        name: securities
+    issueDate:
+      label: Date issued
+      type: date
+    maturityDate:
+      label: Maturity date
+      type: date
+    type:
+      label: Type
+    classification:
+      label: Classification
+    collateral:
+      label: Collateral

followthemoney/schema/Similar.yaml

@@ -0,0 +1,37 @@
+Similar:
+  label: Similar
+  plural: Similar entities
+  description: >
+    A link between two entities that are presumed to be the same, e.g. as the
+    outcome of a probabilistic record linkage process.
+  matchable: false
+  generated: true
+  featured:
+    - candidate
+    - match
+    - confidenceScore
+  caption:
+    - confidenceScore
+    - criteria
+  properties:
+    candidate:
+      label: "Candidate"
+      type: entity
+      range: Thing
+      reverse:
+        name: candidateSimilars
+        label: "Similar to this"
+    match:
+      label: "Match"
+      type: entity
+      range: Thing
+      reverse:
+        name: matchSimilars
+        label: "Similar as this"
+    confidenceScore:
+      label: Confidence score
+      type: number
+    criteria:
+      label: Matching criteria
+    matcher:
+      label: Matcher

followthemoney/schema/Succession.yaml

@@ -0,0 +1,36 @@
+Succession:
+  label: "Succession"
+  plural: "Successions"
+  description: "Two entities that legally succeed each other."
+  extends:
+    - Interest
+  matchable: false
+  featured:
+    - predecessor
+    - successor
+    - date
+  required:
+    - predecessor
+    - successor
+  edge: # PREDECESSOR preceeds SUCCESSOR
+    source: predecessor
+    label: "preceeds"
+    target: successor
+    directed: true
+    caption:
+      - date
+  properties:
+    predecessor:
+      label: "Predecessor"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: successors
+        label: "Successors"
+    successor:
+      label: "Successor"
+      type: entity
+      range: LegalEntity
+      reverse:
+        name: predecessors
+        label: "Predecessors"

followthemoney/schema/Table.yaml

@@ -0,0 +1,32 @@
+Table:
+  extends:
+    - Document
+  label: Table
+  plural: Tables
+  description: >
+    A document structured into rows and cells. This includes simple CSV files, spreadsheet
+    sheets or database relations.
+  matchable: false
+  generated: true
+  featured:
+    - title
+    - fileName
+    - mimeType
+    - parent
+  caption:
+    - title
+    - name
+    - fileName
+  properties:
+    columns:
+      label: "Column headings"
+      hidden: true
+      type: json
+    rowCount:
+      label: "Number of rows"
+      type: number
+    csvHash:
+      label: "CSV alternative version checksum"
+      hidden: true
+      type: checksum
+      matchable: false

followthemoney/schema/TaxRoll.yaml

@@ -1,22 +1,40 @@
 TaxRoll:
-  label: Tax Roll
-  plural: Tax Rolls
-  extends: Interval
+  label: "Tax roll"
+  plural: "Tax rolls"
+  description: "A tax declaration of an individual"
+  extends:
+    - Interval
   icon: fa-bank
   matchable: false
   featured:
+    - taxee
     - date
     - income
     - wealth
     - taxPaid
+  required:
+    - taxee
   properties:
-    person:
-      label: Person
+    taxee:
+      label: "Taxee"
       type: entity
-      schema: Person
+      range: LegalEntity
+      reverse:
+        name: taxRolls
+        label: "Tax rolls"
+    country:
+      label: "Country"
+      type: country
+    surname:
+      label: "Surname"
+    givenName:
+      label: "Given name"
+    birthDate:
+      label: "Birth date"
+      type: date
     income:
-      label: Registered income
+      label: "Registered income"
     taxPaid:
-      label: Amount of tax paid
+      label: "Amount of tax paid"
     wealth:
-      label: Registered wealth
+      label: "Registered wealth"

followthemoney/schema/Thing.yaml

@@ -1,28 +1,26 @@
 Thing:
+  # Kein Ding, digga, das Ding hat swing.
+  # Root type of all entities that should be rendered in Aleph.
   abstract: true
-  icon: fa-circle
   matchable: false
   featured:
     - name
     - country
+  required:
+    - name
+  caption:
+    - name
   properties:
     name:
       label: Name
       type: name
-      caption: true
-      required: true
       rdf: http://www.w3.org/2004/02/skos/core#prefLabel
-    sameAs:
-      label: "Same as"
-      type: entity
-      range: Thing
-      rdf: http://www.w3.org/2002/07/owl#sameAs
-      reverse:
-        name: sameAs
     summary: # a short one-liner kind of description
       label: Summary
+      type: text
     description: # a longer description
       label: Description
+      type: text
     country:
       label: Country
       type: country
@@ -34,19 +32,77 @@ Thing:
       label: Previous name
       type: name
     weakAlias:
-      label: Weak aliass
+      label: Weak alias
+      type: name
+      matchable: false
     sourceUrl:
       label: Source link
       type: url
+      matchable: false
+    publisher:
+      label: "Publishing source"
+      matchable: false
+    publisherUrl:
+      label: "Publishing source URL"
+      type: url
+      matchable: false
     alephUrl:
-      label: Federated Aleph link
+      label: Aleph URL
       type: url
+      hidden: true
+      matchable: false
+    wikipediaUrl:
+      label: Wikipedia Article
+      type: url
+    wikidataId:
+      label: Wikidata ID
+      type: identifier
+      format: qid
+      maxLength: 32
     keywords:
       label: Keywords
+    topics:
+      label: Topics
+      type: topic
     address:
       label: Address
       type: address
+    addressEntity:
+      label: Address
+      reverse:
+        name: things
+        label: "Located there"
+      type: entity
+      range: Address
     program: # Used by sanctions
       label: Program
     notes:
-      label: Notes
+      label: Notes
+      type: text
+    proof:
+      label: Source document
+      reverse:
+        name: proven
+        label: "Derived entities"
+      type: entity
+      range: Document
+    indexText:
+      # This is a leaked abstraction from aleph. The idea is to have some
+      # additional text field that can be used to associate searchable text
+      # with an entity. This will be removed as a property upon indexing so
+      # that it can never be retrieved.
+      label: Index text
+      hidden: true
+      type: text
+    createdAt:
+      label: "Created at"
+      type: date
+      matchable: false
+    modifiedAt:
+      label: "Modified on"
+      type: date
+      matchable: false
+    retrievedAt:
+      label: "Retrieved on"
+      type: date
+      matchable: false