Metadata-Version: 2.1
Name: txr
Version: 2.0.1
Summary: TXR: The teXt aRchiver - archives text as text. and much more.
Home-page: https://github.com/idanmiara/txr
Author: Idan Miara
Author-email: idan@miara.com
License: GPL3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6.0
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: crypto
Requires-Dist: cryptography ; extra == 'crypto'

TXR: the teXt aRchiver
########################

Mainly purposed for archiving text files as text files, but can archive any file and not only as text.
`txr` was inspired by tar, gzip and gunzip.
License: GPL v3 or later.

The `txr` format is composed of two files with the following extensions:

* `.txr` - a comma delimited index file (text).
* `.txd` - a data file (can either be text or binary). By default it is concatenation of the input files, separated by a sentinel).


`txr` uses:

* sha256 (for optional hashing, by default).
* zlib (for optional compressing).
* cryptography (for optional encrypting).


Install:
===========

>>> pip install txr

`txr` is a standalone application (It consist of a single source file `txr.py`).
Using the above command installs `txr` both as a console script and as a python module.
If you wish you could also just copy `txr.py` and use it as a standalone app.


Basic Usage:
=================

Archive a folder (or a single file)

>>> txr c:\my_input

Extracting a `txr` file:

>>> txr -x c:\my_input.txr

See detailed help with all available parameters:

>>> txr

Contributions are welcome.

