https://github.com/rubenhortas/pdfmetadata

PDF metadata reader. Scan PDF files looking for their metadata.
https://github.com/rubenhortas/pdfmetadata

metadata metadata-extraction metadata-extractor pdf pdf-metadata python python-3 python-app python-application python3

Last synced: 2 months ago
JSON representation

PDF metadata reader. Scan PDF files looking for their metadata.

• Host: GitHub
• URL: https://github.com/rubenhortas/pdfmetadata
• Owner: rubenhortas
• Created: 2013-09-08T10:45:14.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T11:25:35.000Z (8 months ago)
• Last Synced: 2025-03-25T21:02:09.533Z (3 months ago)
• Topics: metadata, metadata-extraction, metadata-extractor, pdf, pdf-metadata, python, python-3, python-app, python-application, python3
• Language: Python
• Homepage:
• Size: 151 KB
• Stars: 7
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# pdfMetadata

pdfMetadata is a python script that gets and displays metadata from

PDF files.

pdfMetadata can extract data from one PDF file or for all PDF files in a directory (scans recursively).

![GitHub repo file count](https://img.shields.io/github/directory-file-count/rubenhortas/pdfMetadata)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/rubenhortas/pdfMetadata)

![GitHub repo size](https://img.shields.io/github/repo-size/rubenhortas/pdfMetadata)

![GitHub issues](https://img.shields.io/github/issues-raw/rubenhortas/pdfMetadata?logo=github)

![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/rubenhortas/pdfMetadata?logo=github)

![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/rubenhortas/pdfMetadata?&logo=github)

![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/rubenhortas/pdfMetadata?logo=github)

![GitHub all releases](https://img.shields.io/github/downloads/rubenhortas/pdfMetadata/total?logo=github)

## REQUIREMENTS

* Python3

* PyPDF2

* colorama

## INSTALLATION

### Create a virtual environment (or venv)

```shell

python3 -m venv pmvenv

```

*You only have to do this the first time*

### Activate the venv

* Linux/macOS

```shell

source pmvenv/bin/activate

```

* Windows

```shell

pmvenv\Scripts\activate

```

*You have to activate the venv every time you want to use it*

### Install the requirements

```shell

pip install -r requirements.txt

```

*You only have to do this the first time*

## USAGE

```shell

python3 pdfmetadata options

```

```shell

usage: pdfMetadata [-h] [-t [log_file.txt]] [-c [log_file.csv]] [-a] ARGUMENTS [ARGUMENTS ...]

Scan pdf files looking for their metadata.

positional arguments:

  ARGUMENTS             file[s] or path[s] to scan pdf files

options:

  -h, --help            show this help message and exit

  -t [log_file.txt], --txt [log_file.txt]

                        Saves the output into a plain text file.

  -c [log_file.csv], --csv [log_file.csv]

                        Saves the output into a csv file.

  -a, --show-all        Shows scanned non-PDF files.

```

## Troubleshooting

In case of any problem create an [issue](https://github.com/rubenhortas/pdfMetadata/issues/new)

## Discussions

If you want ask (or answer) a question, leave an opinion or have an open-ended conversation you can create (or join)

a [discussion](https://github.com/rubenhortas/pdfMetadata/discussions/new)

## Support

If you find this application useful you can star this repo.