README.md 3.16 KB
Newer Older
jvoisin's avatar
jvoisin committed
1
2
3
4
5
6
7
8
```
 _____ _____ _____ ___ 
|     |  _  |_   _|_  |  Keep you data,
| | | |     | | | |  _|     trash your meta!
|_|_|_|__|__| |_| |___|
                       
```

jvoisin's avatar
jvoisin committed
9
10
11
[![pipeline status](https://0xacab.org/jvoisin/mat2/badges/master/pipeline.svg)](https://0xacab.org/jvoisin/mat2/commits/master)
[![coverage report](https://0xacab.org/jvoisin/mat2/badges/master/coverage.svg)](https://0xacab.org/jvoisin/mat2/commits/master)

12
13
14
This software is currently in **beta**, please don't use it for anything
critical.

jvoisin's avatar
jvoisin committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Metadata and privacy

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 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. 

This is precisely the job of MAT2: getting rid, as much as possible, of
metadata.
jvoisin's avatar
jvoisin committed
30

jvoisin's avatar
jvoisin committed
31
32
33
34
35
36
37
# Requirements

- `python3-mutagen` for audio support
- `python3-gi-cairo` and `gir1.2-poppler-0.18` for PDF support
- `gir1.2-gdkpixbuf-2.0` for images support
- `libimage-exiftool-perl` for everything else

38
39
Please note that MAT2 requires at least Python3.5, meaning that it
doesn't run on [Debian Jessie](Stretc://packages.debian.org/jessie/python3),
jvoisin's avatar
jvoisin committed
40

41
# Running the testsuite
jvoisin's avatar
jvoisin committed
42
43
44
45

```bash
$ python3 -m unittest discover -v
```
jvoisin's avatar
jvoisin committed
46

jvoisin's avatar
jvoisin committed
47
48
49
# Supported formats

```bash
jvoisin's avatar
jvoisin committed
50
$ python3 ./mat2 -l
jvoisin's avatar
jvoisin committed
51
52
```

jvoisin's avatar
jvoisin committed
53
54
55
56
57
# Related softwares

- The first iteration of [MAT](http://mat.boum.org)
- [Exiftool](https://sno.phy.queensu.ca/~phil/exiftool/mat)
- [pdf-redact-tools](https://github.com/firstlookmedia/pdf-redact-tools), that
58
	tries to deal with *printer dots* too.
jvoisin's avatar
jvoisin committed
59
60
- [pdfparanoia](https://github.com/kanzure/pdfparanoia), that removes
	watermarks from PDF.
jvoisin's avatar
jvoisin committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# License

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

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 Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Copyright 2018 Julien (jvoisin) Voisin <julien.voisin+mat2@dustri.org>

# Thanks

MAT2 wouldn't existe without:

jvoisin's avatar
jvoisin committed
83
84
- the [Google Summer of Code](https://summerofcode.withgoogle.com/);
- the fine people from [Tails]( https://tails.boum.org);
jvoisin's avatar
jvoisin committed
85
86
87
88
- friends

Many thanks to them!