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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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