From ff4204517d4a13504bd6cab38f41b6c9ca0c958c Mon Sep 17 00:00:00 2001 From: Andros Fenollosa Date: Fri, 31 Aug 2018 09:22:23 +0200 Subject: [PATCH] Update README --- README.md | 26 ++++++++++++++++++++++++++ organize_my_photos.py | 2 +- setup.py | 4 ++-- 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4d10382..0c1caa7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ # organize-my-photos + Terminal program that organizes and organizes the photographs in folders by year, month and day. #python #terminal + +## Install + +``` bash +pip3 install --user Organize-my-photos +``` + +## Run + +``` bash +organize_my_photos [PATH] +``` + +## Example + +``` bash +organize_my_photos travel +``` + +## Options + +| FLAG | DESCRIPTION | EXAMPLE | +| :--: | :--: | :--: | +| --locale | Specifies the language of the months. | organize_my_photos --locale es_ES | +| --extension | Change file extension for sorting. | organize_my_photos --extension mp4 | diff --git a/organize_my_photos.py b/organize_my_photos.py index 443bfe8..e407709 100644 --- a/organize_my_photos.py +++ b/organize_my_photos.py @@ -13,7 +13,7 @@ EXTENSIONS = ('jpg', 'jpeg', 'gif') @click.command() @click.argument('path') @click.option('--locale', default=False, help='Specifies the language of the months. Example: es_ES') -@click.option('--extension', default=False, help='change file extension for sorting.') +@click.option('--extension', default=False, help='Change file extension for sorting.') def organize_my_photos(path, locale, extension): """ Sort in folder all photos """ # Set locale diff --git a/setup.py b/setup.py index 46fbada..b6bfd74 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ from setuptools import setup setup( name = 'Organize-my-photos', py_modules=['organize_my_photos'], - version = '1.0.0', + version = '1.0.1', python_requires='>3.6', description = 'Terminal program that organizes and organizes the photographs in folders by year, month and day.', author = 'Andros Fenollosa', @@ -19,6 +19,6 @@ setup( ], entry_points=''' [console_scripts] - ad=organize_my_photos:organize_my_photos + organize_my_photos=organize_my_photos:organize_my_photos ''' )