snapsheets


Namesnapsheets JSON
Version 1.1.1 PyPI version JSON
download
home_pagehttps://qumasan.gitlab.io/snapsheets/
SummaryQuick and Easy Downloader for Public Google Spreadsheets
upload_time2024-10-04 08:57:44
maintainerNone
docs_urlNone
authorshotakaha
requires_python<4.0,>=3.10
licenseMIT
keywords wget googlesheet
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![GitLab pipeline](https://img.shields.io/gitlab/pipeline/qumasan/snapsheets?style=for-the-badge)
![PyPI - Licence](https://img.shields.io/pypi/l/snapsheets?style=for-the-badge)
![PyPI](https://img.shields.io/pypi/v/snapsheets?style=for-the-badge)
![PyPI - Status](https://img.shields.io/pypi/status/snapsheets?style=for-the-badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/snapsheets?style=for-the-badge)

# Snapsheets

Effortlessly download public Google Spreadsheets in bulk!

Tired of downloading Google Spreadsheets one by one through your browser? Snapsheets is here to save you time and effort! With this tool, you can quickly grab multiple Google Spreadsheets straight from your terminal --- all you need is a public link to the sheets.

No more repetitive clicking. No more hassle. No auth needed. Just fast and easy spreadsheet downloading!

---

# Install

```console
$ pip3 install snapsheets
```

```console
$ pipx install snapsheets
```

```console
$ uv tool install snapsheets
```

# Usage

```bash
$ snapsheets --url="copy_and_paste_url_here"
2022-06-09T08:09:31 | SUCCESS  | 🤖 Downloaded snapshot.csv
2022-06-09T08:09:31 | SUCCESS  | 🚀 Renamed to _snapshot.csv
```

# Docs and Repository

- GitLab Pages : https://qumasan.gitlab.io/snapsheets/
- GitLab Repos : https://gitlab.com/qumasan/snapsheets/
- PyPI package : https://pypi.org/project/snapsheets/

![PyPI - Downloads](https://img.shields.io/pypi/dd/snapsheets?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dw/snapsheets?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dm/snapsheets?style=for-the-badge)

# Help

```bash
snapsheets -h
usage: snapsheets [-h] [--config config | --url url] [-o filename]
                  [-d description] [-t format] [--skip] [--debug]
                  [--version]

snapsheets

options:
  -h, --help       show this help message and exit
  --config config  set config file or directory
  --url url        set URL of Google spreadsheet
  -o filename      set output filename
  -d description   set description of a spreadsheet
  -t format        set datetime prefix for backup filename
  --skip           skip file
  --debug          show more messages
  --version        show program's version number and exit
```

- For Sheet-mode: Use ``--url`` option to download single spreadsheet.
- For Book-mode: Use ``--config`` option to download multiple spreadsheets.
  - create a directory for config files.
  - create a config file in TOML format.

# Examples

## Book-mode: with ``--config`` argument

```bash
$ snapsheets --config="config/"
2022-06-09T08:05:48 | SUCCESS  | 🤖 Downloaded filename.csv
2022-06-09T08:05:48 | SUCCESS  | 🚀 Renamed to 2022_filename.csv
2022-06-09T08:05:49 | SUCCESS  | 🤖 Downloaded filename.csv
2022-06-09T08:05:49 | SUCCESS  | 🚀 Renamed to 20220609_filename.csv
```

## Sheet-mode: with ``--url`` argument

```bash
snapsheets --url "https://docs.google.com/spreadsheets/d/1NbSH0rSCLkElG4UcNVuIhmg5EfjAk3t8TxiBERf6kBM/edit?gid=0#gid=0"
2024-10-02T17:25:06 | SUCCESS  | 🤖 Downloaded as snapshot.csv
2024-10-02T17:25:06 | SUCCESS  | 🚀 Renamed to _snapshot.csv
```

- Downloaded file is temporarily named as ``snapshot.csv``, then renamed to ``_snapshot.csv``.

- Make ``./config/`` directory and place your TOML files.
  - If ``./config/`` does not exist, it will search from ``. (current directory)``.
- Downloaded files are saved to ``./snapd/`` directory
  - If ``./snapd/`` does not exit, it will be saved in ``. (current directory)``.

## As module: ``import snapsheets``

```python
from snapsheets.sheet import Sheet

url = "https://docs.google.com/spreadsheets/d/1NbSH0rSCLkElG4UcNVuIhmg5EfjAk3t8TxiBERf6kBM/edit#gid=0"
sheet = Sheet(url=url, desc="Get Sample Sheet")
sheet.snapshot()

📣 Get Sample Sheet
🤖 Downloaded snapshot.csv
🚀 Renamed to 20220602T225044_snapshot.csv
```

---

# Other requirements

- Install ``wget`` if your system doesn't have them
- Make your spreadsheet available with shared link (OK with read-only)

            

Raw data

            {
    "_id": null,
    "home_page": "https://qumasan.gitlab.io/snapsheets/",
    "name": "snapsheets",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "wget, googlesheet",
    "author": "shotakaha",
    "author_email": "shotakaha+py@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/dc/31/59e3b49e57cbc9fccca5b8b1a3a871f9fd4128e96b4ce1c5191354017708/snapsheets-1.1.1.tar.gz",
    "platform": null,
    "description": "![GitLab pipeline](https://img.shields.io/gitlab/pipeline/qumasan/snapsheets?style=for-the-badge)\n![PyPI - Licence](https://img.shields.io/pypi/l/snapsheets?style=for-the-badge)\n![PyPI](https://img.shields.io/pypi/v/snapsheets?style=for-the-badge)\n![PyPI - Status](https://img.shields.io/pypi/status/snapsheets?style=for-the-badge)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/snapsheets?style=for-the-badge)\n\n# Snapsheets\n\nEffortlessly download public Google Spreadsheets in bulk!\n\nTired of downloading Google Spreadsheets one by one through your browser? Snapsheets is here to save you time and effort! With this tool, you can quickly grab multiple Google Spreadsheets straight from your terminal --- all you need is a public link to the sheets.\n\nNo more repetitive clicking. No more hassle. No auth needed. Just fast and easy spreadsheet downloading!\n\n---\n\n# Install\n\n```console\n$ pip3 install snapsheets\n```\n\n```console\n$ pipx install snapsheets\n```\n\n```console\n$ uv tool install snapsheets\n```\n\n# Usage\n\n```bash\n$ snapsheets --url=\"copy_and_paste_url_here\"\n2022-06-09T08:09:31 | SUCCESS  | \ud83e\udd16 Downloaded snapshot.csv\n2022-06-09T08:09:31 | SUCCESS  | \ud83d\ude80 Renamed to _snapshot.csv\n```\n\n# Docs and Repository\n\n- GitLab Pages : https://qumasan.gitlab.io/snapsheets/\n- GitLab Repos : https://gitlab.com/qumasan/snapsheets/\n- PyPI package : https://pypi.org/project/snapsheets/\n\n![PyPI - Downloads](https://img.shields.io/pypi/dd/snapsheets?style=for-the-badge)\n![PyPI - Downloads](https://img.shields.io/pypi/dw/snapsheets?style=for-the-badge)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/snapsheets?style=for-the-badge)\n\n# Help\n\n```bash\nsnapsheets -h\nusage: snapsheets [-h] [--config config | --url url] [-o filename]\n                  [-d description] [-t format] [--skip] [--debug]\n                  [--version]\n\nsnapsheets\n\noptions:\n  -h, --help       show this help message and exit\n  --config config  set config file or directory\n  --url url        set URL of Google spreadsheet\n  -o filename      set output filename\n  -d description   set description of a spreadsheet\n  -t format        set datetime prefix for backup filename\n  --skip           skip file\n  --debug          show more messages\n  --version        show program's version number and exit\n```\n\n- For Sheet-mode: Use ``--url`` option to download single spreadsheet.\n- For Book-mode: Use ``--config`` option to download multiple spreadsheets.\n  - create a directory for config files.\n  - create a config file in TOML format.\n\n# Examples\n\n## Book-mode: with ``--config`` argument\n\n```bash\n$ snapsheets --config=\"config/\"\n2022-06-09T08:05:48 | SUCCESS  | \ud83e\udd16 Downloaded filename.csv\n2022-06-09T08:05:48 | SUCCESS  | \ud83d\ude80 Renamed to 2022_filename.csv\n2022-06-09T08:05:49 | SUCCESS  | \ud83e\udd16 Downloaded filename.csv\n2022-06-09T08:05:49 | SUCCESS  | \ud83d\ude80 Renamed to 20220609_filename.csv\n```\n\n## Sheet-mode: with ``--url`` argument\n\n```bash\nsnapsheets --url \"https://docs.google.com/spreadsheets/d/1NbSH0rSCLkElG4UcNVuIhmg5EfjAk3t8TxiBERf6kBM/edit?gid=0#gid=0\"\n2024-10-02T17:25:06 | SUCCESS  | \ud83e\udd16 Downloaded as snapshot.csv\n2024-10-02T17:25:06 | SUCCESS  | \ud83d\ude80 Renamed to _snapshot.csv\n```\n\n- Downloaded file is temporarily named as ``snapshot.csv``, then renamed to ``_snapshot.csv``.\n\n- Make ``./config/`` directory and place your TOML files.\n  - If ``./config/`` does not exist, it will search from ``. (current directory)``.\n- Downloaded files are saved to ``./snapd/`` directory\n  - If ``./snapd/`` does not exit, it will be saved in ``. (current directory)``.\n\n## As module: ``import snapsheets``\n\n```python\nfrom snapsheets.sheet import Sheet\n\nurl = \"https://docs.google.com/spreadsheets/d/1NbSH0rSCLkElG4UcNVuIhmg5EfjAk3t8TxiBERf6kBM/edit#gid=0\"\nsheet = Sheet(url=url, desc=\"Get Sample Sheet\")\nsheet.snapshot()\n\n\ud83d\udce3 Get Sample Sheet\n\ud83e\udd16 Downloaded snapshot.csv\n\ud83d\ude80 Renamed to 20220602T225044_snapshot.csv\n```\n\n---\n\n# Other requirements\n\n- Install ``wget`` if your system doesn't have them\n- Make your spreadsheet available with shared link (OK with read-only)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Quick and Easy Downloader for Public Google Spreadsheets",
    "version": "1.1.1",
    "project_urls": {
        "Homepage": "https://qumasan.gitlab.io/snapsheets/",
        "Repository": "https://gitlab.com/qumasan/snapsheets/"
    },
    "split_keywords": [
        "wget",
        " googlesheet"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "50b5af33ba0234199827dcad913392ef98ab0a3041abfd7985205347b76f4641",
                "md5": "70799914250e0bee9b16a822544af737",
                "sha256": "2f5966fa58191a3765b91804c14052a75771df4bbe2730765eb305a6b32648b1"
            },
            "downloads": -1,
            "filename": "snapsheets-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "70799914250e0bee9b16a822544af737",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 14635,
            "upload_time": "2024-10-04T08:57:43",
            "upload_time_iso_8601": "2024-10-04T08:57:43.054788Z",
            "url": "https://files.pythonhosted.org/packages/50/b5/af33ba0234199827dcad913392ef98ab0a3041abfd7985205347b76f4641/snapsheets-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dc3159e3b49e57cbc9fccca5b8b1a3a871f9fd4128e96b4ce1c5191354017708",
                "md5": "194bdb78dd8ca7a1a0ca59cbc73ea38e",
                "sha256": "35bb2cb3ec5dcb3690c09ea07acbe55241babf730bd6c43c15cc0f44d53089a2"
            },
            "downloads": -1,
            "filename": "snapsheets-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "194bdb78dd8ca7a1a0ca59cbc73ea38e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 13012,
            "upload_time": "2024-10-04T08:57:44",
            "upload_time_iso_8601": "2024-10-04T08:57:44.986983Z",
            "url": "https://files.pythonhosted.org/packages/dc/31/59e3b49e57cbc9fccca5b8b1a3a871f9fd4128e96b4ce1c5191354017708/snapsheets-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-04 08:57:44",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "qumasan",
    "gitlab_project": "snapsheets",
    "lcname": "snapsheets"
}
        
Elapsed time: 0.71933s