https://github.com/karrlab/gdoc_down
Command line programs to save Google documents to text and LaTeX files
https://github.com/karrlab/gdoc_down
command-line google-docs google-drive google-drive-api latex
Last synced: 5 months ago
JSON representation
Command line programs to save Google documents to text and LaTeX files
- Host: GitHub
- URL: https://github.com/karrlab/gdoc_down
- Owner: KarrLab
- License: mit
- Created: 2015-12-31T15:35:42.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T13:31:49.000Z (over 5 years ago)
- Last Synced: 2025-05-21T22:53:18.902Z (8 months ago)
- Topics: command-line, google-docs, google-drive, google-drive-api, latex
- Language: Python
- Homepage:
- Size: 105 KB
- Stars: 15
- Watchers: 7
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.python.org/pypi/gdoc_down)
[](http://docs.karrlab.org/gdoc_down)
[](https://circleci.com/gh/KarrLab/gdoc_down)
[](https://coveralls.io/github/KarrLab/gdoc_down)
[](https://codeclimate.com/github/KarrLab/gdoc_down)
[](LICENSE)
# `gdoc-down`
API and command line program to save Google documents, presentations, and worksheets in a local Google Drive / Backup & Sync
directory to local files.
`gdoc-down` supports several formats:
* CSV (.csv)
* EPUB (.epub)
* Excel workbook (.xlsx)
* HTML (.html)
* Image (.png, .jpg, .svg)
* LaTeX (.tex)
* Open Office document (.odt)
* Open Office presentation (.odp)
* Open Office workbook (.ods)
* Plain text file (.txt)
* Portable document format (.pdf)
* Powerpoint presentation (.pptx)
* Rich text document (.rtf)
* TSV (.tsv)
* Word document (.docx)
`gdoc-down` also has special features for handling .gdoc files that contain LaTeX:
* `gdoc-down` ignores all images. This allows the user to place images inside the Google
document for convenience and to use `\includegraphics` to embed images in compile PDF files.
* `gdoc-down` will convert all Google document comments to PDF comments.
* `gdoc-down` ignores all page breaks.
The first time `gdoc-down` is called, `gdoc-down` will request access to the user's Google
account. This will create a client.json file in the users home directory (~/.gdoc_down/client.json).
## Installation
* Latest release from PyPI
```
pip install gdoc_down
```
* Latest revision from GitHub
```
pip install git+https://github.com/KarrLab/gdoc_down.git#egg=gdoc_down
```
## Command line usage
```
usage: gdoc-down (sub-commands ...) [options ...] {arguments ...}
Download a Google document, presentation, or workbook to a local file
positional arguments:
google_file path to Google document, presentation, or workbook
optional arguments:
-h, --help show this help message and exit
--debug toggle debug output
--quiet suppress all output
--format FORMAT, -f FORMAT
output format (csv, docx, epub, html, jpg, odft, odp,
ods, pdf, pptx, png, rtf, svg, tsv, tex, txt, xlsx)
--out_path OUT_PATH, -o OUT_PATH
path where Google document, presentation, or workbook
should be downloaded
--extension EXTENSION, -e EXTENSION
output extension
```
## Examples
```
gdoc-down -f docx /path/to/Google \Drive/file.gdoc
gdoc-down -f pptx /path/to/Google \Drive/file.gslides
gdoc-down -f xlsx /path/to/Google \Drive/file.gsheet
```
## Documentation
Please see the documentation at [Read the Docs](http://docs.karrlab.org/gdoc_down).
## Tests
`pytest` can be used to run the tests:
```
pytest tests
```
Please note that several additional packages are required for testing (see [tests/requirements.txt](tests/requirements.txt)).
## License
The example model is released under the [MIT license](LICENSE).
## Development team
`gdoc-down` was developed by [Jonathan Karr](http://www.karrlab.org) at the Icahn School of Medicine at Mount Sinai in New York, USA.
## Questions and comments
Please contact the [Jonathan Karr](http://www.karrlab.org) with any questions or comments.