Skip to content

README.md

Latest commit

 

History

History
80 lines (60 loc) · 2.8 KB

README.md

File metadata and controls

80 lines (60 loc) · 2.8 KB

MetaPy

Simple pythonic CLI application for image metadata collection and (optionally) delete it. Run on Windows and Unix-based OS.

Required libraries

  • Pillow (PIL fork)

Features

  • Open Source
  • Python-based, full CLI application
  • Logging on:
    • User level (info)
    • Developer level (debug, error)
  • Force option

How to use

Clone repository

git clone https://github.com/carlosm00/MetaPy.git

Run CLI application

Run through terminal providing absolute route file or source.

python metapy.py C:\example\folder

After reading the metadata of the file, you will be asked if you wish to create a copy of the image without metadata. The script will only accept a 'yes' (lowercase), otherwise, it ill consider you don't want the copy. There is a way to force the copy without being asked by using the '-f' after the path:

python metapy.py C:\example\folder -f

Please, note that more than three (3) arguments will be considered a wrong use of the script.

Tests and 'Source' folder

For testing purposes, we created a 'Source' folder containing the following files:

File Type Description Test result
full_negative png Corrupted file Error: Invalid file
positive_no_meta jpg Plain image without metadata Only size and mode
full_positive jpg Phone-taken camera Full metadata output and duplication without metadata

Extra notes

Why Pillow?

Pillow as the successor of PIL offers faster data-accessing methods and powerful optimized processing capabilities, with a continued contribution as a live project. Reference:

- https://python-pillow.org/
- https://pillow.readthedocs.io/en/stable/index.html
- https://github.com/python-pillow/Pillow

Logging

For logging capabilities, we use the built-in 'Logging' facility. Reference and documentation:

- https://docs.python.org/3/library/logging.html

imghdr for image validator

The imghdr builtin module is not used as it gets deprecated on 3.11. Opening the window for future versions. Reference:

- https://docs.python.org/3/library/imghdr.html
- https://peps.python.org/pep-0594/

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/your_feature)
  3. Commit your Changes (git commit -m 'Added x feature')
  4. Push to the Branch (git push origin feature/your_feature)
  5. Open a Pull Request