| Name | organize-photos JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | Python CLI program that allows you to organize your photos into subfolders based on their EXIF metadata. |
| upload_time | 2023-10-16 23:13:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2023 ohmycoffe
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
photos
images
multimedia
organize
exif
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# organize-photos
The `organize-photos` is a Python CLI program that allows you to organize your photos into subfolders based on their EXIF metadata. You can define a custom pattern to create new paths for your photos, making it easy to sort and categorize your image collection.
## Features
- Organize photos based on EXIF metadata such as date and time taken.
- Customize the path structure using a template with placeholders for year, month, day, hour, minute, and second.
- Copy and rename images to the destination directory, maintaining the folder structure specified by the template.
- Supports UNIX-style glob patterns for selecting files in the source directory.
## Installation
### Development
Prerequisites: [pdm](https://pdm.fming.dev/latest/) for environment management
1. Clone this repository.
```bash
git clone https://github.com/ohmycoffe/organize-photos.git
```
2. Navigate to the project directory.
```bash
cd organize-photos
```
3. Install the required dependencies using pdm.
```bash
pdm install -G dev
```
Install pre-commit.
```bash
pdm run pre-commit install
```
4. Run tests.
```bash
pdm run pytest
```
> **_NOTE:_** This repository supports also GNU Make commands
```bash
make help
```
## Usage
You can easily install the latest released version using binary installers from the Python Package Index (PyPI):
```sh
pip install organize-photos --user
```
- `source-dir`: The source directory containing the photos you want to organize.
- `-d, --dest-dir`: The destination directory where copied and renamed images will be saved. If not provided, the default is the current working directory.
- `-t, --template`: The template for generating new file paths. Customize the path structure using placeholders such as `${year}`, `${month}`, `${day}`, `${hour}`, `${minute}`, and `${second}`.
- `-p, --file-pattern`: The pattern for selecting files in the source directory. Use UNIX-style glob patterns to filter which files will be processed. The default is to process all files.
## Example
```bash
organize-photos /path/to/source/photos -d /path/to/output -t "${year}/${year}${month}${day}${hour}${minute}${second}" -p "**/*.jpg"
```
This command will organize the photos in the source directory based on the specified template and file pattern and save the organized photos in the destination directory.
For instance, if you have a file located at `/path/to/source/photos/image1.jpeg`, which was created on `January 3, 2019, at 20:54:12`, the program creates a copy of the file at `/path/to/output/2019/20190103205412.jpeg` following the specified pattern.
## License
`organize-photos` is released under the [MIT License](LICENSE).
## Author
- ohmycoffe
- GitHub: [ohmycoffe](https://github.com/ohmycoffe)
Raw data
{
"_id": null,
"home_page": "",
"name": "organize-photos",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "photos images multimedia organize exif",
"author": "",
"author_email": "ohmycoffe <ohmycoffe1@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/44/9b/9243799205fff56d2344c0b2d1d28136bf6c036543d99a28cfa902b489e0/organize_photos-0.1.0.tar.gz",
"platform": null,
"description": "\n# organize-photos\n\nThe `organize-photos` is a Python CLI program that allows you to organize your photos into subfolders based on their EXIF metadata. You can define a custom pattern to create new paths for your photos, making it easy to sort and categorize your image collection.\n\n## Features\n\n- Organize photos based on EXIF metadata such as date and time taken.\n- Customize the path structure using a template with placeholders for year, month, day, hour, minute, and second.\n- Copy and rename images to the destination directory, maintaining the folder structure specified by the template.\n- Supports UNIX-style glob patterns for selecting files in the source directory.\n\n## Installation\n\n### Development\nPrerequisites: [pdm](https://pdm.fming.dev/latest/) for environment management \n1. Clone this repository.\n\n```bash\ngit clone https://github.com/ohmycoffe/organize-photos.git\n```\n\n2. Navigate to the project directory.\n\n```bash\ncd organize-photos\n```\n\n3. Install the required dependencies using pdm.\n\n```bash\npdm install -G dev\n```\nInstall pre-commit.\n```bash\npdm run pre-commit install\n```\n\n4. Run tests.\n\n```bash\npdm run pytest\n```\n> **_NOTE:_** This repository supports also GNU Make commands\n```bash\nmake help\n```\n\n## Usage\n\nYou can easily install the latest released version using binary installers from the Python Package Index (PyPI):\n\n```sh\npip install organize-photos --user\n```\n\n- `source-dir`: The source directory containing the photos you want to organize.\n- `-d, --dest-dir`: The destination directory where copied and renamed images will be saved. If not provided, the default is the current working directory.\n- `-t, --template`: The template for generating new file paths. Customize the path structure using placeholders such as `${year}`, `${month}`, `${day}`, `${hour}`, `${minute}`, and `${second}`.\n- `-p, --file-pattern`: The pattern for selecting files in the source directory. Use UNIX-style glob patterns to filter which files will be processed. The default is to process all files.\n\n## Example\n\n```bash\norganize-photos /path/to/source/photos -d /path/to/output -t \"${year}/${year}${month}${day}${hour}${minute}${second}\" -p \"**/*.jpg\"\n```\n\nThis command will organize the photos in the source directory based on the specified template and file pattern and save the organized photos in the destination directory.\nFor instance, if you have a file located at `/path/to/source/photos/image1.jpeg`, which was created on `January 3, 2019, at 20:54:12`, the program creates a copy of the file at `/path/to/output/2019/20190103205412.jpeg` following the specified pattern.\n\n## License\n\n`organize-photos` is released under the [MIT License](LICENSE).\n\n## Author\n\n- ohmycoffe\n- GitHub: [ohmycoffe](https://github.com/ohmycoffe)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2023 ohmycoffe\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Python CLI program that allows you to organize your photos into subfolders based on their EXIF metadata.",
"version": "0.1.0",
"project_urls": {
"Repository": "https://github.com/ohmycoffe/organize-photos"
},
"split_keywords": [
"photos",
"images",
"multimedia",
"organize",
"exif"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07bf1a9dc6f4328f2f14f95b2d5bfa6e741d40efc64b0f419ef338e07dcfb960",
"md5": "5a794faa7be822573110ad147354a39f",
"sha256": "e73877ed31bd0bb1e05e3abe9a92b6289291f10f1c4066da56b51dbc0c9ff70c"
},
"downloads": -1,
"filename": "organize_photos-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a794faa7be822573110ad147354a39f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10091,
"upload_time": "2023-10-16T23:13:53",
"upload_time_iso_8601": "2023-10-16T23:13:53.482247Z",
"url": "https://files.pythonhosted.org/packages/07/bf/1a9dc6f4328f2f14f95b2d5bfa6e741d40efc64b0f419ef338e07dcfb960/organize_photos-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "449b9243799205fff56d2344c0b2d1d28136bf6c036543d99a28cfa902b489e0",
"md5": "ae71c46c92b3c6d0ad7bbc21548aebe5",
"sha256": "2a0f6c71056da33efc93f7330dcf07f33cdcb16e197a8279a9eabebc20332d3e"
},
"downloads": -1,
"filename": "organize_photos-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ae71c46c92b3c6d0ad7bbc21548aebe5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11490,
"upload_time": "2023-10-16T23:13:55",
"upload_time_iso_8601": "2023-10-16T23:13:55.353124Z",
"url": "https://files.pythonhosted.org/packages/44/9b/9243799205fff56d2344c0b2d1d28136bf6c036543d99a28cfa902b489e0/organize_photos-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-16 23:13:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ohmycoffe",
"github_project": "organize-photos",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "organize-photos"
}
