Metadata-Version: 2.1
Name: tsmtool
Version: 1.1.1
Summary: Top-level package for tsmtool.
Keywords: tsmtool
Author-email: Matt Krueger <mkrueger@rstms.net>
Description-Content-Type: text/markdown
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: bs4==0.0.1
Requires-Dist: click==8.0.4
Requires-Dist: requests==2.27.1
Requires-Dist: black==22.1.0 ; extra == "dev"
Requires-Dist: bump2version==1.0.1 ; extra == "dev"
Requires-Dist: coverage==6.3.2 ; extra == "dev"
Requires-Dist: flake8==4.0.1 ; extra == "dev"
Requires-Dist: flit==3.7.1 ; extra == "dev"
Requires-Dist: pytest==7.1.1 ; extra == "dev"
Requires-Dist: pytest-datadir==1.3.1 ; extra == "dev"
Requires-Dist: tox==3.24.5 ; extra == "dev"
Requires-Dist: m2r2==0.3.2 ; extra == "docs"
Requires-Dist: Sphinx==4.5.0 ; extra == "docs"
Requires-Dist: sphinx-click==3.1.0 ; extra == "docs"
Requires-Dist: sphinx-rtd-theme==1.0.0 ; extra == "docs"
Project-URL: Home, https://github.com/rstms/tsmtool
Provides-Extra: dev
Provides-Extra: docs

# Tarsnap Status Monitor Reporting Tool


[![Image](https://img.shields.io/github/license/rstms/tsmtool)](https://raw.githubusercontent.com/rstms/tsmtool/master/LICENSE)

[![Image](https://img.shields.io/pypi/v/tsmtool.svg)](https://pypi.org/project/tsmtool/)

[![Image](https://circleci.com/gh/rstms/tsmtool/tree/master.svg?style=shield)](https://app.circleci.com/pipelines/github/rstms/tsmtool?branch=master&filter=all)

[![Image](https://readthedocs.org/projects/tsmtool/badge/?version=latest)](http://tsmtool.readthedocs.io/)

[![Image](https://pyup.io/repos/github/rstms/tsmtool/shield.svg)](https://pyup.io/account/repos/github/rstms/tsmtool/)

Tarsnap Status Monitor

## Introduction 
The most excellent backup service [Tarsnap](https://www.tarsnap.com) provides a clean
and functional interface for managing one's account.  This tool connects to that web
interface and queries data, producing a JSON-formated report.  The current balance is
read, and an estimated monthly cost is calculated based on the site's daily cost data.

### Example Output
Here's an example of output from the author's tarsnap account:
```
(tsmtool) mkrueger@beaker:~/src/tsmtool$ tsmtool rstms
{
  "balance": 32.51,
  "account": "mkrueger@rstms.net",
  "monthly_cost": 23.51
}
```

## Configuration 
A config file may be used for account data, or the email account / password may be passed as command line options.
The config file is a whitespace delimited text file with one line per account.
Each line has these fields:

`~/.tsmtool`: 
```
ACCOUNT_NAME    EMAIL_ADDRESS   PASSWORD
```

* Free software: MIT license
* Documentation: https://tsmtool.readthedocs.io.



## Credits

[Tarsnap](https://www.tarsnap.com) 

This package was created with Cookiecutter and `rstms/cookiecutter-python-cli`, a fork of the `audreyr/cookiecutter-pypackage` project template.

[audreyr/cookiecutter](https://github.com/audreyr/cookiecutter)
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
[rstms/cookiecutter-python-cli](https://github.com/rstms/cookiecutter-python-cli)

