README.md 3.52 KB
Newer Older
jvoisin's avatar
jvoisin committed
1 2 3 4 5 6 7
[![Travis-CI build status]( https://travis-ci.org/jvoisin/MAT.svg?branch=master )]( https://travis-ci.org/jvoisin/MAT )
[![Coveralls status]( https://coveralls.io/repos/jvoisin/MAT/badge.svg?branch=master&service=github )]( https://coveralls.io/github/jvoisin/MAT?branch=master )
[![codecov.io status]( https://codecov.io/github/jvoisin/MAT/coverage.svg?branch=master )]( https://codecov.io/github/jvoisin/MAT?branch=master )
[![Landascape.io status](https://landscape.io/github/jvoisin/MAT/master/landscape.svg?style=flat)](https://landscape.io/github/jvoisin/MAT/master)
[![Codacy status]( https://api.codacy.com/project/badge/grade/17830b47b8db4878ac0560906050809c )]( https://www.codacy.com/app/julien-voisin/MAT )


jvoisin's avatar
jvoisin committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
METADATA
========
Metadata consist of information that characterizes data.
Metadata are used to provide documentation for data products.
In essence, metadata answer who, what, when, where, why, and how about
every facet of the data that are being documented.

METADATA AND PRIVACY
====================
Metadata within a file can tell a lot about you.
Cameras record data about when a picture was taken and what
camera was used. Office documents like PDF or Office automatically adds
author and company information to documents and spreadsheets.
Maybe you don't want to disclose those information on the web.

WARNINGS
========
See README.security

DEPENDENCIES
============
 * python2.7 (at least)

OPTIONALS DEPENDENCIES
======================
jvoisin's avatar
jvoisin committed
33
 * python-mutagen: for massive audio format support
jvoisin's avatar
jvoisin committed
34
 * exiftool: for image format support
jvoisin's avatar
jvoisin committed
35 36 37
 * python-pdfrw, gir-poppler and python-gi-cairo for full PDF support
 * python-gi for the GUI
 * shred (should be already installed)
jvoisin's avatar
jvoisin committed
38 39 40

USAGE
=====
jvoisin's avatar
jvoisin committed
41 42 43

For the command line:

jvoisin's avatar
jvoisin committed
44
    mat --help
jvoisin's avatar
jvoisin committed
45 46

or for the graphical interface:
jvoisin's avatar
jvoisin committed
47 48 49 50 51

    mat-gui

SUPPORTED FORMAT
================
fr33 tux's avatar
fr33 tux committed
52
See ./data/FORMATS
jvoisin's avatar
jvoisin committed
53 54 55

HOW TO IMPLEMENT NEW FORMATS
============================
fr33 tux's avatar
fr33 tux committed
56
1. Add the format's mimetype to the STRIPPER list in strippers.py
jvoisin's avatar
jvoisin committed
57 58 59 60 61 62
2. Inherit the GenericParser class (parser.py)
3. Read the parser.py module
4. Implement at least these three methods:
    - is_clean(self)
    - remove_all(self)
    - get_meta(self)
jvoisin's avatar
jvoisin committed
63
5. Don't forget to call the do_backup() method if necessary
jvoisin's avatar
jvoisin committed
64 65 66

HOW TO LAUNCH THE TESTSUITE
===========================
jvoisin's avatar
jvoisin committed
67 68

    python setup.py test
jvoisin's avatar
jvoisin committed
69 70 71 72

LINKS
=====
* Official website: https://mat.boum.org
jvoisin's avatar
jvoisin committed
73
* Bugtracker: https://labs.riseup.net/code/projects/mat
jvoisin's avatar
jvoisin committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
* Git repo: https://gitweb.torproject.org/user/jvoisin/mat.git

CONTACT
=======
If you have question, patches, bug reports, or simply want to talk about this project,
please use the mailing list (https://mailman.boum.org/listinfo/mat-dev).
You can also contact contact jvoisin
on irc.oftc.net or at julien.voisin@dustri.org.

LICENSE
=======
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2 as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.

jvoisin's avatar
jvoisin committed
99
Copyright 2011-2015 Julien (jvoisin) Voisin <julien.voisin@dustri.org>
jvoisin's avatar
jvoisin committed
100 101 102

THANKS
======
jvoisin's avatar
jvoisin committed
103
Mat would not exist without:
jvoisin's avatar
jvoisin committed
104 105 106

 * the Google Summer of Code,
 * the hachoir library,
jvoisin's avatar
jvoisin committed
107
 * people on #tails@oftc and the Tails project
jvoisin's avatar
jvoisin committed
108

jvoisin's avatar
jvoisin committed
109
Many thanks to them!