searcch.importer.db.model package

Submodules

searcch.importer.db.model.license module

searcch.importer.db.model.license.recognize_license(text)

Module contents

class searcch.importer.db.model.Affiliation(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

org

org_id

person

person_id

class searcch.importer.db.model.Artifact(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The Artifact class provides an internal model of a SEARCCH artifact. An artifact is an entity that may be added to or edited within the SEARCCH Hub.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

affiliations

badges

candidate_relationships

ctime

curations

description

ext_id

files

fundings

has_author(name=None, email=None, allow_none_match=True)

has_tag(tag, source=None, ignore_case=False, allow_none_match=True)

id

import_session

importer

importer_id

license

license_id

meta

mtime

name

owner

owner_id

publication

relationships

releases

set_import_session(import_session)

tags

title

type

url

venues

class searcch.importer.db.model.ArtifactAffiliation(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

affiliation

affiliation_id

artifact_id

id

roles

class searcch.importer.db.model.ArtifactBadge(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

badge

badge_id

id

class searcch.importer.db.model.ArtifactCuration(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

curator

curator_id

id

notes

opdata

time

class searcch.importer.db.model.ArtifactFile(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

file_content

file_content_id

filetype

id

members

mtime

name

size

url

class searcch.importer.db.model.ArtifactFileMember(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

download_url

file_content

file_content_id

filetype

html_url

id

mtime

name

parent_file

parent_file_id

pathname

size

class searcch.importer.db.model.ArtifactFunding(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

funding_org_id

grant_number

grant_title

grant_url

id

organization

class searcch.importer.db.model.ArtifactImport(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

ArtifactImport represents an ongoing or completed artifact import session, for server-triggered imports.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact

artifact_id

bytes_extracted

bytes_retrieved

ctime

id

importer_module_name

log

message

mtime

noextract

nofetch

noremove

phase

progress

remote_id

type

url

class searcch.importer.db.model.ArtifactMetadata(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

id

name

source

type

value

class searcch.importer.db.model.ArtifactPublication(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

id

notes

publisher

publisher_id

time

class searcch.importer.db.model.ArtifactRelationship(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The ArtifactRelationship class declares a relationship between two SEARCCH artifacts.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

id

related_artifact

related_artifact_id

relation

class searcch.importer.db.model.ArtifactRelease(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

author_email

author_login

author_name

id

notes

tag

time

title

url

class searcch.importer.db.model.ArtifactTag(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

id

source

tag

class searcch.importer.db.model.ArtifactVenue(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact_id

id

venue

venue_id

class searcch.importer.db.model.Badge(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

description

doi

id

image_url

issue_time

organization

title

url

venue

verified

version

class searcch.importer.db.model.CandidateArtifact(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The CandidateArtifact class allows possible/recommended (“candidate”), yet-to-be-imported Artifacts to be declared. These have not been imported, so cannot be placed in the main Artifacts table. We also need to model possible relationships between both candidates and existing artifacts.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

candidate_artifact_relationships

ctime

description

id

imported_artifact

imported_artifact_id

meta

mtime

name

owner

owner_id

title

type

url

class searcch.importer.db.model.CandidateArtifactMetadata(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

candidate_artifact_id

id

name

source

type

value

class searcch.importer.db.model.CandidateArtifactRelationship(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The CandidateArtifactRelationship class declares a relationship between an artifact and a candidate.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

artifact

artifact_id

id

related_candidate

related_candidate_id

relation

class searcch.importer.db.model.CandidateRelationship(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The CandidateRelationship class declares a relationship between two candidate artifacts.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

candidate_artifact_id

id

related_candidate

related_candidate_id

relation

class searcch.importer.db.model.ExportedObject(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

The ExportedObject class tracks system objects that have been exported. The idea is that each object can only be exported to a single destination once without clearing its presence in this table.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

ctime

exporter

exporter_id

external_object_id

id

object_id

object_type

class searcch.importer.db.model.Exporter(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

name

version

class searcch.importer.db.model.Extractor(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

name

version

class searcch.importer.db.model.FileContent(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

content

classmethod find_existing(session, content)

hash

id

classmethod make_hash(content)

size

class searcch.importer.db.model.Importer(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

name

version

class searcch.importer.db.model.License(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

long_name

short_name

url

verified

class searcch.importer.db.model.Organization(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

address

country

id

latitude

longitude

name

state

type

url

verified

class searcch.importer.db.model.Person(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

email

id

meta

name

class searcch.importer.db.model.PersonMetadata(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

name

person_id

source

value

class searcch.importer.db.model.RecurringVenue(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

abbrev

description

id

publisher_url

recurrences

title

type

url

verified

class searcch.importer.db.model.User(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

id

person

person_id

class searcch.importer.db.model.UserAuthorization(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

roles

scope

scoped_id

user_id

class searcch.importer.db.model.Venue(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

abbrev

description

doi

end_day

id

isbn

issn

issue

location

month

publisher

publisher_location

publisher_url

recurring_venue

recurring_venue_id

start_day

title

type

url

verified

volume

year

searcch.importer.db.model.file_content_fixups(mapper, connection, target)