pic-chrono 1.0.0

A tool to automaticallly rename images to their respective date-time taken

PicChrono

Description

A python package helping you to archive your photos. It renames the photos based on the date and time they were taken.

Prerequisites

Before you begin, ensure that you have the following prerequisites installed:

• Python (version 3.10 or higher), refer to python's website to install it.
• pip, refer to pip's official documentation to install it.

Installation

Install the package using pip:

pip install pic-chrono

or

pip install git+https://github.com/kondakoffer/PicChrono

It is recommended to use a virtual environment to install the package (see here).

Usage

Once the package is installed, you can use it as a command line tool or as a python package.

As command line tool

The intended usage is as command line tool. You can use it as follows:

PicChrono [OPTIONS] SOURCE_PATH [DESTINATION_DIR] [ERROR_DIR]  

• SOURCE_PATH: The path to the directory containing the photos you want to rename. You can also specify a single file by using its path.
• DESTINATION_DIR: The path to the directory where you want to save the renamed photos. If not specified, the photos will be stored in the current directory.
• ERROR_DIR: The path to the directory where you want to save the photos that could not be renamed. If not specified, the photos will be stored in the current directory.

Options

• --help: Show the help message and exit.
• -v or --version: Show the version number and exit.

As python package

It is also possible to integrate the package into your own python code by using the typical python import statement:

import pic_chrono

If you only want to use the functionalities with renaming the photos, you can import the Rename class:

from pic_chrono.renamer import Rename

Troubleshooting

If you encounter any issues or errors, here are a few troubleshooting tips:

• Double-check that package is installed correctly.
• Consult the project's documentation or issue tracker for common troubleshooting steps.
• If the issue persists, feel free to open a new issue here.

Contributing

Any contributions are welcome! Please follow the contributing guidelines and the code of conduct.

License

This project is licensed under the MIT-LICENSE. Please review the license terms before using the project. Since this project uses other packages, you must also agree and follow their license agreements. You can find the license agreements of the packages used in the NOTICES.md file.

Acknowledgements

Since this project uses other software and packages, we would like to thank the authors of these for their work. This includes Poetry, Python, Pillow, Typer, rich, pytest, pytest-cov, black, coverage-badge.