{py:mod}archivebox.seeds.models

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`Seed <archivebox.seeds.models.Seed>`
  - ```{autodoc2-docstring} archivebox.seeds.models.Seed
    :summary:
    ```

API

:canonical: archivebox.seeds.models.Seed

Bases: {py:obj}`abid_utils.models.ABIDModel`, {py:obj}`abid_utils.models.ModelWithHealthStats`

```{autodoc2-docstring} archivebox.seeds.models.Seed
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.seeds.models.Seed.__init__
```

````{py:attribute} abid_prefix
:canonical: archivebox.seeds.models.Seed.abid_prefix
:value: >
   'src_'

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid_prefix
```

````

````{py:attribute} abid_ts_src
:canonical: archivebox.seeds.models.Seed.abid_ts_src
:value: >
   'self.created_at'

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid_ts_src
```

````

````{py:attribute} abid_uri_src
:canonical: archivebox.seeds.models.Seed.abid_uri_src
:value: >
   'self.uri'

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid_uri_src
```

````

````{py:attribute} abid_subtype_src
:canonical: archivebox.seeds.models.Seed.abid_subtype_src
:value: >
   'self.extractor'

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid_subtype_src
```

````

````{py:attribute} abid_rand_src
:canonical: archivebox.seeds.models.Seed.abid_rand_src
:value: >
   'self.id'

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid_rand_src
```

````

````{py:attribute} abid_drift_allowed
:canonical: archivebox.seeds.models.Seed.abid_drift_allowed
:value: >
   True

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid_drift_allowed
```

````

````{py:attribute} id
:canonical: archivebox.seeds.models.Seed.id
:value: >
   'UUIDField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.id
```

````

````{py:attribute} abid
:canonical: archivebox.seeds.models.Seed.abid
:value: >
   'ABIDField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.abid
```

````

````{py:attribute} uri
:canonical: archivebox.seeds.models.Seed.uri
:value: >
   'URLField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.uri
```

````

````{py:attribute} label
:canonical: archivebox.seeds.models.Seed.label
:value: >
   'CharField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.label
```

````

````{py:attribute} notes
:canonical: archivebox.seeds.models.Seed.notes
:value: >
   'TextField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.notes
```

````

````{py:attribute} extractor
:canonical: archivebox.seeds.models.Seed.extractor
:value: >
   'CharField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.extractor
```

````

````{py:attribute} tags_str
:canonical: archivebox.seeds.models.Seed.tags_str
:value: >
   'CharField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.tags_str
```

````

````{py:attribute} config
:canonical: archivebox.seeds.models.Seed.config
:value: >
   'JSONField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.config
```

````

````{py:attribute} created_at
:canonical: archivebox.seeds.models.Seed.created_at
:value: >
   'AutoDateTimeField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.created_at
```

````

````{py:attribute} modified_at
:canonical: archivebox.seeds.models.Seed.modified_at
:value: >
   'DateTimeField(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.modified_at
```

````

````{py:attribute} created_by
:canonical: archivebox.seeds.models.Seed.created_by
:value: >
   'ForeignKey(...)'

```{autodoc2-docstring} archivebox.seeds.models.Seed.created_by
```

````

````{py:attribute} crawl_set
:canonical: archivebox.seeds.models.Seed.crawl_set
:type: django.db.models.Manager[crawls.models.Crawl]
:value: >
   None

```{autodoc2-docstring} archivebox.seeds.models.Seed.crawl_set
```

````

`````{py:class} Meta
:canonical: archivebox.seeds.models.Seed.Meta

```{autodoc2-docstring} archivebox.seeds.models.Seed.Meta
```

````{py:attribute} verbose_name
:canonical: archivebox.seeds.models.Seed.Meta.verbose_name
:value: >
   'Seed'

```{autodoc2-docstring} archivebox.seeds.models.Seed.Meta.verbose_name
```

````

````{py:attribute} verbose_name_plural
:canonical: archivebox.seeds.models.Seed.Meta.verbose_name_plural
:value: >
   'Seeds'

```{autodoc2-docstring} archivebox.seeds.models.Seed.Meta.verbose_name_plural
```

````

````{py:attribute} unique_together
:canonical: archivebox.seeds.models.Seed.Meta.unique_together
:value: >
   (('created_by', 'uri', 'extractor'),)

```{autodoc2-docstring} archivebox.seeds.models.Seed.Meta.unique_together
```

````

`````

````{py:method} from_file(source_file: pathlib.Path, label: str = '', parser: str = 'auto', tag: str = '', created_by: int | None = None, config: dict | None = None)
:canonical: archivebox.seeds.models.Seed.from_file
:classmethod:

```{autodoc2-docstring} archivebox.seeds.models.Seed.from_file
```

````

````{py:property} source_type
:canonical: archivebox.seeds.models.Seed.source_type

```{autodoc2-docstring} archivebox.seeds.models.Seed.source_type
```

````

````{py:property} api_url
:canonical: archivebox.seeds.models.Seed.api_url
:type: str

````

````{py:property} api_docs_url
:canonical: archivebox.seeds.models.Seed.api_docs_url
:type: str

````

````{py:property} scheduled_crawl_set
:canonical: archivebox.seeds.models.Seed.scheduled_crawl_set
:type: django.db.models.QuerySet[crawls.models.CrawlSchedule]

```{autodoc2-docstring} archivebox.seeds.models.Seed.scheduled_crawl_set
```

````

````{py:property} snapshot_set
:canonical: archivebox.seeds.models.Seed.snapshot_set
:type: django.db.models.QuerySet[core.models.Snapshot]

```{autodoc2-docstring} archivebox.seeds.models.Seed.snapshot_set
```

````