Skip to main content

Tool to backup a turtl account.

Project description

Turtl Backup
============

This program permits to download a whole turtl account for offline
backuping, and optionally decrypt the backup file, then optionally
export the decrypted file to markdown.


Installation
------------

You can install ``turtl-backup`` using pip:
```bash
pip3 install turtl-backup
```

Usage
-----

There's a graphical user interface:
```bash
turtl-backup-gui
```

And a command line tool, here's its usage:
```bash
usage: turtl-backup [-h] {backup,get_auth_token,export} ...

Backup a turtl account.

positional arguments:
{backup,get_auth_token,export}
Backup can be done with a login/password pair or using
an auth token.
backup Backup a turtl account (with a password or an auth
token)
get_auth_token Get a turtl auth token
export Decrypt and export all notes in the given directory.

optional arguments:
-h, --help show this help message and exit
```

So typically to create an encrypted backup:
```bash
$ turtl-backup backup https://api.framanotes.org backup.json
username: test
password:
```

To decrypt a backup:
```bash
$ turtl-backup decrypt backup.json backup/
username: test
password:
```

To export a decrypted backup to markdown:
```bash
$ turtl-backup export backup/ backup-md/
$ cat backup-md/Hello.md
type: text
title: Hello
tags: []
url: None
username: None
password: None

world
```

FAQ
---

> Is it possible to setup a cron to backup my notes without storing my
login/password in plaintext in my crontab?

Yes, the turtl ``auth_token`` is enough to backup an account. You can
get your auth token using ``turtl-backup get_auth_token``, but still
be carefull not to leak it. Then use ``turtl-backup
backup --auth-token YOUR_AUTH_TOKEN``.


> Is it possible to decrypt my notes using my ``auth_token``?

No, you'll need your login and password again.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

turtl-backup-0.1.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

turtl_backup-0.1.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file turtl-backup-0.1.0.tar.gz.

File metadata

  • Download URL: turtl-backup-0.1.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.19.2 CPython/3.7.3rc1

File hashes

Hashes for turtl-backup-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2bc498825a09a82eafe5a77b7bd824218aedc86db87c8c126f2a5d15b621b54b
MD5 c866440dc14351b99f6670e07a59c475
BLAKE2b-256 dc28a1b3a1e50a4990ccfe4cce68114c49615ef2134ca78d5d7de9551ed20731

See more details on using hashes here.

File details

Details for the file turtl_backup-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: turtl_backup-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.19.2 CPython/3.7.3rc1

File hashes

Hashes for turtl_backup-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21b134fb7253c52cfcb9ca97f09275f321f64b4a5be0c3145e972a369fe818b3
MD5 e42ed90bbaa60827c5dd6a5cd788d25e
BLAKE2b-256 a0a7b830bedd2d21d1c65dcbbec7025340672ef03e054761634fea485dd7b5ee

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page