# {py:mod}`snapsheets.v0.core`

```{py:module} snapsheets.v0.core
```

```{autodoc2-docstring} snapsheets.v0.core
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Config <snapsheets.v0.core.Config>`
  - ```{autodoc2-docstring} snapsheets.v0.core.Config
    :summary:
    ```
* - {py:obj}`Sheet <snapsheets.v0.core.Sheet>`
  - ```{autodoc2-docstring} snapsheets.v0.core.Sheet
    :summary:
    ```
* - {py:obj}`Book <snapsheets.v0.core.Book>`
  - ```{autodoc2-docstring} snapsheets.v0.core.Book
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`cli <snapsheets.v0.core.cli>`
  - ```{autodoc2-docstring} snapsheets.v0.core.cli
    :summary:
    ```
````

### API

`````{py:class} Config
:canonical: snapsheets.v0.core.Config

```{autodoc2-docstring} snapsheets.v0.core.Config
```

````{py:attribute} confd
:canonical: snapsheets.v0.core.Config.confd
:type: str
:value: >
   './config/'

```{autodoc2-docstring} snapsheets.v0.core.Config.confd
```

````

````{py:attribute} saved
:canonical: snapsheets.v0.core.Config.saved
:type: str
:value: >
   './snapd/'

```{autodoc2-docstring} snapsheets.v0.core.Config.saved
```

````

````{py:attribute} logf
:canonical: snapsheets.v0.core.Config.logf
:type: str
:value: >
   None

```{autodoc2-docstring} snapsheets.v0.core.Config.logf
```

````

````{py:attribute} size
:canonical: snapsheets.v0.core.Config.size
:type: int
:value: >
   1000000

```{autodoc2-docstring} snapsheets.v0.core.Config.size
```

````

````{py:attribute} backups
:canonical: snapsheets.v0.core.Config.backups
:type: int
:value: >
   10

```{autodoc2-docstring} snapsheets.v0.core.Config.backups
```

````

````{py:method} __post_init__() -> None
:canonical: snapsheets.v0.core.Config.__post_init__

```{autodoc2-docstring} snapsheets.v0.core.Config.__post_init__
```

````

````{py:method} check_path(path: str) -> str
:canonical: snapsheets.v0.core.Config.check_path
:staticmethod:

```{autodoc2-docstring} snapsheets.v0.core.Config.check_path
```

````

````{py:method} check_paths() -> None
:canonical: snapsheets.v0.core.Config.check_paths

```{autodoc2-docstring} snapsheets.v0.core.Config.check_paths
```

````

````{py:method} reset_config()
:canonical: snapsheets.v0.core.Config.reset_config

```{autodoc2-docstring} snapsheets.v0.core.Config.reset_config
```

````

````{py:method} get_fnames(pattern: str) -> typing.List[pathlib.Path]
:canonical: snapsheets.v0.core.Config.get_fnames

```{autodoc2-docstring} snapsheets.v0.core.Config.get_fnames
```

````

````{py:method} load_yaml() -> typing.Dict[typing.Any, typing.Any]
:canonical: snapsheets.v0.core.Config.load_yaml

```{autodoc2-docstring} snapsheets.v0.core.Config.load_yaml
```

````

````{py:method} load_toml() -> typing.Dict[typing.Any, typing.Any]
:canonical: snapsheets.v0.core.Config.load_toml

```{autodoc2-docstring} snapsheets.v0.core.Config.load_toml
```

````

````{py:method} update_config(config, new)
:canonical: snapsheets.v0.core.Config.update_config

```{autodoc2-docstring} snapsheets.v0.core.Config.update_config
```

````

````{py:method} load_config() -> None
:canonical: snapsheets.v0.core.Config.load_config

```{autodoc2-docstring} snapsheets.v0.core.Config.load_config
```

````

````{py:method} get_config()
:canonical: snapsheets.v0.core.Config.get_config

```{autodoc2-docstring} snapsheets.v0.core.Config.get_config
```

````

````{py:method} sections() -> typing.List[str]
:canonical: snapsheets.v0.core.Config.sections

```{autodoc2-docstring} snapsheets.v0.core.Config.sections
```

````

````{py:method} volumes() -> typing.Optional[str]
:canonical: snapsheets.v0.core.Config.volumes

```{autodoc2-docstring} snapsheets.v0.core.Config.volumes
```

````

````{py:method} options() -> typing.Optional[str]
:canonical: snapsheets.v0.core.Config.options

```{autodoc2-docstring} snapsheets.v0.core.Config.options
```

````

````{py:method} datefmt() -> typing.Optional[str]
:canonical: snapsheets.v0.core.Config.datefmt

```{autodoc2-docstring} snapsheets.v0.core.Config.datefmt
```

````

````{py:method} sheets() -> typing.Any
:canonical: snapsheets.v0.core.Config.sheets

```{autodoc2-docstring} snapsheets.v0.core.Config.sheets
```

````

````{py:method} sheet_names() -> typing.Any
:canonical: snapsheets.v0.core.Config.sheet_names

```{autodoc2-docstring} snapsheets.v0.core.Config.sheet_names
```

````

````{py:method} sheet(name: str) -> typing.Any
:canonical: snapsheets.v0.core.Config.sheet

```{autodoc2-docstring} snapsheets.v0.core.Config.sheet
```

````

`````

`````{py:class} Sheet
:canonical: snapsheets.v0.core.Sheet

Bases: {py:obj}`snapsheets.v0.core.Config`

```{autodoc2-docstring} snapsheets.v0.core.Sheet
```

````{py:attribute} url
:canonical: snapsheets.v0.core.Sheet.url
:type: typing.Union[str, typing.Optional[str]]
:value: >
   None

```{autodoc2-docstring} snapsheets.v0.core.Sheet.url
```

````

````{py:attribute} key
:canonical: snapsheets.v0.core.Sheet.key
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} snapsheets.v0.core.Sheet.key
```

````

````{py:attribute} gid
:canonical: snapsheets.v0.core.Sheet.gid
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} snapsheets.v0.core.Sheet.gid
```

````

````{py:attribute} fmt
:canonical: snapsheets.v0.core.Sheet.fmt
:type: str
:value: >
   'xlsx'

```{autodoc2-docstring} snapsheets.v0.core.Sheet.fmt
```

````

````{py:attribute} desc
:canonical: snapsheets.v0.core.Sheet.desc
:type: typing.Optional[str]
:value: >
   'snapsheet'

```{autodoc2-docstring} snapsheets.v0.core.Sheet.desc
```

````

````{py:attribute} fname
:canonical: snapsheets.v0.core.Sheet.fname
:type: typing.Optional[str]
:value: >
   None

```{autodoc2-docstring} snapsheets.v0.core.Sheet.fname
```

````

````{py:attribute} name
:canonical: snapsheets.v0.core.Sheet.name
:type: typing.Optional[str]
:value: >
   'snapsheet'

```{autodoc2-docstring} snapsheets.v0.core.Sheet.name
```

````

````{py:attribute} datefmt
:canonical: snapsheets.v0.core.Sheet.datefmt
:type: typing.Optional[str]
:value: >
   '%Y%m%dT%H%M%S'

```{autodoc2-docstring} snapsheets.v0.core.Sheet.datefmt
```

````

````{py:attribute} skip
:canonical: snapsheets.v0.core.Sheet.skip
:type: bool
:value: >
   False

```{autodoc2-docstring} snapsheets.v0.core.Sheet.skip
```

````

````{py:method} __post_init__() -> None
:canonical: snapsheets.v0.core.Sheet.__post_init__

```{autodoc2-docstring} snapsheets.v0.core.Sheet.__post_init__
```

````

````{py:method} set_name()
:canonical: snapsheets.v0.core.Sheet.set_name

```{autodoc2-docstring} snapsheets.v0.core.Sheet.set_name
```

````

````{py:method} set_savef() -> None
:canonical: snapsheets.v0.core.Sheet.set_savef

```{autodoc2-docstring} snapsheets.v0.core.Sheet.set_savef
```

````

````{py:method} set_key_gid_from_url() -> None
:canonical: snapsheets.v0.core.Sheet.set_key_gid_from_url

```{autodoc2-docstring} snapsheets.v0.core.Sheet.set_key_gid_from_url
```

````

````{py:method} info() -> None
:canonical: snapsheets.v0.core.Sheet.info

```{autodoc2-docstring} snapsheets.v0.core.Sheet.info
```

````

````{py:method} load(sheet: typing.Dict[str, typing.Any]) -> None
:canonical: snapsheets.v0.core.Sheet.load

```{autodoc2-docstring} snapsheets.v0.core.Sheet.load
```

````

````{py:method} export_url() -> str
:canonical: snapsheets.v0.core.Sheet.export_url

```{autodoc2-docstring} snapsheets.v0.core.Sheet.export_url
```

````

````{py:method} check_fmt() -> None
:canonical: snapsheets.v0.core.Sheet.check_fmt

```{autodoc2-docstring} snapsheets.v0.core.Sheet.check_fmt
```

````

````{py:method} download() -> str
:canonical: snapsheets.v0.core.Sheet.download

```{autodoc2-docstring} snapsheets.v0.core.Sheet.download
```

````

````{py:method} backup() -> str
:canonical: snapsheets.v0.core.Sheet.backup

```{autodoc2-docstring} snapsheets.v0.core.Sheet.backup
```

````

````{py:method} snapshot()
:canonical: snapsheets.v0.core.Sheet.snapshot

```{autodoc2-docstring} snapsheets.v0.core.Sheet.snapshot
```

````

`````

`````{py:class} Book
:canonical: snapsheets.v0.core.Book

Bases: {py:obj}`snapsheets.v0.core.Config`

```{autodoc2-docstring} snapsheets.v0.core.Book
```

````{py:attribute} sheets
:canonical: snapsheets.v0.core.Book.sheets
:type: typing.List[snapsheets.v0.core.Sheet]
:value: >
   'field(...)'

```{autodoc2-docstring} snapsheets.v0.core.Book.sheets
```

````

````{py:method} __post_init__()
:canonical: snapsheets.v0.core.Book.__post_init__

```{autodoc2-docstring} snapsheets.v0.core.Book.__post_init__
```

````

````{py:method} get_sheet_names()
:canonical: snapsheets.v0.core.Book.get_sheet_names

```{autodoc2-docstring} snapsheets.v0.core.Book.get_sheet_names
```

````

````{py:method} get_sheet_dict(name: str)
:canonical: snapsheets.v0.core.Book.get_sheet_dict

```{autodoc2-docstring} snapsheets.v0.core.Book.get_sheet_dict
```

````

````{py:method} make_sheet(name: str) -> snapsheets.v0.core.Sheet
:canonical: snapsheets.v0.core.Book.make_sheet

```{autodoc2-docstring} snapsheets.v0.core.Book.make_sheet
```

````

````{py:method} add_sheet(sheet: snapsheets.v0.core.Sheet) -> None
:canonical: snapsheets.v0.core.Book.add_sheet

```{autodoc2-docstring} snapsheets.v0.core.Book.add_sheet
```

````

````{py:method} snapshots() -> None
:canonical: snapsheets.v0.core.Book.snapshots

```{autodoc2-docstring} snapsheets.v0.core.Book.snapshots
```

````

````{py:method} export_urls() -> None
:canonical: snapsheets.v0.core.Book.export_urls

```{autodoc2-docstring} snapsheets.v0.core.Book.export_urls
```

````

`````

````{py:function} cli() -> None
:canonical: snapsheets.v0.core.cli

```{autodoc2-docstring} snapsheets.v0.core.cli
```
````