`snapsheets.v0.core`

(Deprecated since 1.0.0)

Will be removed from the source code

Usage:
    snapsheets [-h] [--config CONFIG] [--url URL] [-v]

Options:
    -h, --help            show this help message and exit.
    --config CONFIG       set config directory. (default = './config/')
    --url URL             copy and paste an URL of the Google spreadsheet.
    -v, --version         show version and exit.

Module Contents

Classes

`Config`	Config 設定用クラス
`Sheet`	シート用クラス
`Book`	Book A class for collection or spreadsheets

Functions

cli

Command Line Interface for Snapsheets

API

class snapsheets.v0.core.Config

Config 設定用クラス

Parameters

confd: str 設定用のディレクトリ (default: “config/”) saved: str ダウンロード先のディレクトリ (default: “snapd/”) logf: str ログファイルの名前（未実装） size: int ログのサイズ上限（未実装） backups: int バックアップ数（未実装）

confd: str: ‘./config/’

saved: str: ‘./snapd/’

logf: str: None

size: int: 1000000

backups: int: 10

__post_init__() → None

static check_path(path: str) → str

引数 path に渡したディレクトリが存在するかチェックする

ディレクトリが存在しない場合はカレントディレクトリに変更する

Parameters

path: str ディレクトリ名

Returns

path: str ディレクトリ名

check_paths() → None: デフォルト値に指定したパスが存在するかチェックする

reset_config()

get_fnames(pattern: str) → List[pathlib.Path]

load_yaml() → Dict[Any, Any]

load_toml() → Dict[Any, Any]

Load configurations from TOMLs

設定を読み込んだ辞書型をリターンする

初めて読み込む場合 : TOMLを直接代入してOK
2回目以降 : シートの情報だけ追記

update_config(config, new): update config

load_config() → None

get_config()

Get pyproject-like configuration

[tool.snapsheets]

sections() → List[str]

volumes() → Optional[str]

options() → Optional[str]

datefmt() → Optional[str]

sheets() → Any

sheet_names() → Any

sheet(name: str) → Any

class snapsheets.v0.core.Sheet

Bases: snapsheets.v0.core.Config

シート用クラス

Parameters

url: str or None GoogleスプレッドシートのURL key: str or None 該当シートのスプレッドシートID gid: str or None 該当シートのシートID fmt: str ダウンロード形式 (default=“.xlsx”) desc: str or None 該当シートの説明 (default=“snapsheet”) fname: str or None ダウンロードしたときのファイル名 name: str or None 該当シートのID的なもの (default=“snapsheet”) datefmt: str or None ダウンロードしたときの日付フォーマット (default=“%Y%m%dT%H%M%S”) skip: bool スキップ用フラグ (default=False)

url: Union[str, Optional[str]]: None

key: Optional[str]: None

gid: Optional[str]: None

fmt: str: ‘xlsx’

desc: Optional[str]: ‘snapsheet’

fname: Optional[str]: None

name: Optional[str]: ‘snapsheet’

datefmt: Optional[str]: ‘%Y%m%dT%H%M%S’

skip: bool: False

__post_init__() → None

set_name()

set_savef() → None

set_key_gid_from_url() → None

info() → None

load(sheet: Dict[str, Any]) → None

export_url() → str

check_fmt() → None

出力ファイルの形式をチェック

サポートしている形式: .xlsx, .ods, .csv, .tsv
上記以外の拡張子の場合は sys.exit

download() → str

backup() → str

snapshot()

class snapsheets.v0.core.Book

Bases: snapsheets.v0.core.Config

Book A class for collection or spreadsheets

sheets: List[snapsheets.v0.core.Sheet]: ‘field(…)’

__post_init__()

get_sheet_names()

get_sheet_dict(name: str)

make_sheet(name: str) → snapsheets.v0.core.Sheet

Make Sheet object from configuration file

Parameters

name : str Name of sheet in configuration file

Returns

Sheet Sheet

add_sheet(sheet: snapsheets.v0.core.Sheet) → None

Add Sheet object to Book object. Skip when sheet.skip = True.

Parameters

sheet : Sheet 設定ファイルから作成した Sheet オブジェクト

snapshots() → None: Take snapshots of all sheet in the Book

export_urls() → None: Show export URLs

snapsheets.v0.core.cli() → None: Command Line Interface for Snapsheets

snapsheets.v0.core

Module Contents

Classes

Functions

API

`snapsheets.v0.core`