diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 5554df1..2254b65 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -27,7 +27,8 @@ jobs: sudo apt-get install -y libimage-exiftool-perl python -m pip install --upgrade pip pip install pytest - pip install -r requirements-dev.txt + pip install -r requirements.lock + pip install -r requirements-dev.lock - name: Run tests run: pytest diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index cae4a04..2e581e0 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -16,6 +16,8 @@ jobs: steps: - uses: actions/checkout@v4.1.1 - name: Install dependencies - run: pip install -r requirements-dev.txt + run: pip install -r requirements.lock + - name: Install dev dependencies + run: pip install -r requirements-dev.lock - name: Run pre-commit run: pre-commit run -a diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 0435443..e817bc4 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -29,7 +29,8 @@ jobs: run: | sudo apt-get install -y libimage-exiftool-perl python -m pip install --upgrade pip - pip install -r requirements-dev.txt + pip install -r requirements.lock + pip install -r requirements-dev.lock - name: Run tests run: pytest diff --git a/.gitignore b/.gitignore index 58cd8a2..76127af 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,7 @@ __pycache__/ *.py[cod] *$py.class .pytest_cache - +.ruff_cache # C extensions *.so diff --git a/Dockerfile b/Dockerfile index 1bafbe6..3ea6b1a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,16 +1,16 @@ -FROM python:3.10-alpine +FROM python:3.11-alpine VOLUME /mnt/input VOLUME /mnt/output -ENV CRON "" -ENV OPTIONS "" +ENV CRON="" +ENV OPTIONS="" COPY . /opt/phockup RUN chmod +x /opt/phockup/entrypoint.sh RUN apk --no-cache add exiftool \ - && pip install --no-cache-dir -r /opt/phockup/requirements.txt \ + && pip install --no-cache-dir -r /opt/phockup/requirements.lock \ && ln -s /opt/phockup/phockup.py /usr/local/bin/phockup \ && apk add bash \ && apk add flock diff --git a/__main__.py b/__main__.py deleted file mode 100755 index 828aa34..0000000 --- a/__main__.py +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/bin/env python3 -import sys - -from phockup import main -from src.printer import Printer - -if __name__ == '__main__': - try: - main(sys.argv[1:]) - except KeyboardInterrupt: - Printer().empty().line('Exiting...') - sys.exit(0) diff --git a/phockup.py b/phockup.py index c432f57..d53bc44 100755 --- a/phockup.py +++ b/phockup.py @@ -1,409 +1,4 @@ #!/usr/bin/env python3 -import argparse -import logging -import logging.handlers -import os -import re -import sys +from phockup import app -from src.date import Date -from src.dependency import check_dependencies -from src.phockup import Phockup - -__version__ = '1.13.0' - -PROGRAM_DESCRIPTION = """\ -Media sorting tool to organize photos and videos from your camera in folders by year, \ -month and day. -The software will collect all files from the input directory and copy them to the output -directory without changing the files content. It will only rename the files and place -them in the proper directory for year, month and day. -""" - -DEFAULT_DIR_FORMAT = ['%Y', '%m', '%d'] - -logger = logging.getLogger('phockup') - - -def parse_args(args=sys.argv[1:]): - parser = argparse.ArgumentParser( - description=PROGRAM_DESCRIPTION, - formatter_class=argparse.RawTextHelpFormatter) - - parser.version = f"v{__version__}" - - parser.add_argument( - '-v', - '--version', - action='version', - ) - - parser.add_argument( - '-d', - '--date', - action='store', - type=Date.parse, - help="""\ -Specify date format for OUTPUTDIR directories. - -You can choose different year format (e.g. 17 instead of 2017) or decide to skip the -day directories and have all photos sorted in year/month. - -Supported formats: - YYYY - 2016, 2017 ... - YY - 16, 17 ... - MM - 07, 08, 09 ... - M - July, August, September ... - m - Jul, Aug, Sept ... - DD - 27, 28, 29 ... (day of month) - DDD - 123, 158, 365 ... (day of year) - U - 00, 01, 53 ... (week of the year, Sunday first day of week) - W - 00, 01, 53 ... (week of the year, Monday first day of week) - -Example: - YYYY/MM/DD -> 2011/07/17 - YYYY/M/DD -> 2011/July/17 - YYYY/m/DD -> 2011/Jul/17 - YY/m-DD -> 11/Jul-17 - YYYY/U -> 2011/30 - YYYY/W -> 2011/28 -""", - ) - - exclusive_group_link_move = parser.add_mutually_exclusive_group() - - exclusive_group_link_move.add_argument( - '-m', - '--move', - action='store_true', - help="""\ - Instead of copying the process will move all files from the INPUTDIR to the OUTPUTDIR. - This is useful when working with a big collection of files and the remaining free space - is not enough to make a copy of the INPUTDIR. - """, - ) - - exclusive_group_link_move.add_argument( - '-l', - '--link', - action='store_true', - help="""\ - Instead of copying the process will make hard links to all files in INPUTDIR and place - them in the OUTPUTDIR. - This is useful when working with working structure and want to create YYYY/MM/DD - structure to point to same files. - """, - ) - - parser.add_argument( - '-o', - '--original-names', - action='store_true', - help="""\ - Organize the files in selected format or using the default year/month/day format but - keep original filenames. - """, - ) - - parser.add_argument( - '-t', - '--timestamp', - action='store_true', - help="""\ - Use the timestamp of the file (last modified date) if there is no EXIF date information. - If the user supplies a regex, it will be used if it finds a match in the filename. - This option is intended as "last resort" since the file modified date may not be - accurate, nevertheless it can be useful if no other date information can be obtained. - """, - ) - - parser.add_argument( - '-y', - '--dry-run', - action='store_true', - help="""\ - Does a trial run with no permanent changes to the filesystem. - So it will not move any files, just shows which changes would be done. - """, - ) - - parser.add_argument( - '-c', - '--max-concurrency', - type=int, - default=1, - choices=range(1, 255), - metavar='1-255', - help="""\ - Sets the level of concurrency for processing files in a directory. - Defaults to 1. Higher values can improve throughput of file operations - """, - ) - - parser.add_argument( - '--maxdepth', - type=int, - default=-1, - choices=range(0, 255), - metavar='1-255', - help="""\ - Descend at most 'maxdepth' levels (a non-negative integer) of directories - """, - ) - - parser.add_argument( - '-r', - '--regex', - action='store', - type=re.compile, - help="""\ - Specify date format for date extraction from filenames if there is no EXIF date - information. - - Example: - {regex} - can be used to extract the date from file names like the following - IMG_27.01.2015-19.20.00.jpg. - """, - ) - - parser.add_argument( - '-f', - '--date-field', - action='store', - help="""\ - Use a custom date extracted from the exif field specified. - To set multiple fields to try in order until finding a valid date, use spaces to - separate fields inside a string. - - Example: - DateTimeOriginal - "DateTimeOriginal CreateDate FileModifyDate" - - These fields are checked by default when this argument is not set: - "SubSecCreateDate SubSecDateTimeOriginal CreateDate DateTimeOriginal" - - To get all date fields available for a file, do: - exiftool -time:all -mimetype -j - """, - ) - - exclusive_group_debug_silent = parser.add_mutually_exclusive_group() - - exclusive_group_debug_silent.add_argument( - '--debug', - action='store_true', - default=False, - help="""\ - Enable debugging. Alternately, set the LOGLEVEL environment variable to DEBUG - """, - ) - - exclusive_group_debug_silent.add_argument( - '--quiet', - action='store_true', - default=False, - help="""\ - Run without output. - """, - ) - - exclusive_group_debug_silent.add_argument( - '--progress', - action='store_true', - default=False, - help="""\ - Run with progressbar output. - """, - ) - - parser.add_argument( - '--log', - action='store', - help="""\ - Specify the output directory where your log file should be exported. - This flag can be used in conjunction with the flag `--quiet` or `--progress`. - """, - ) - - parser.add_argument( - 'input_dir', - metavar='INPUTDIR', - help="""\ - Specify the source directory where your photos are located. - """, - ) - - parser.add_argument( - 'output_dir', - metavar='OUTPUTDIR', - help="""\ - Specify the output directory where your photos should be exported. - """, - ) - - parser.add_argument( - '--file-type', - type=str, - choices=['image', 'video'], - metavar='image|video', - help="""\ - By default, Phockup addresses both image and video files. - If you want to restrict your command to either images or - videos only, use `--file-type=[image|video]`. - """, - ) - - parser.add_argument( - '--no-date-dir', - type=str, - default=Phockup.DEFAULT_NO_DATE_DIRECTORY, - help="""\ - Files without EXIF date information are placed in a directory - named 'unknown' by default. This option overrides that - folder name. e.g. --no-date-dir=misc, --no-date-dir="no date" - """, - ) - - parser.add_argument( - '--skip-unknown', - action='store_true', - default=False, - help="""\ - Ignore files that don't contain valid EXIF data for the criteria specified. - This is useful if you intend to make multiple passes over an input directory - with varying and specific EXIF fields that are note checked by default. - """, - ) - - parser.add_argument( - '--movedel', - action='store_true', - default=False, - help="""\ - DELETE source files which are determined to be duplicates of files - already transferred. Only valid in conjunction with both `--move` - and `--skip-unknown`. - """, - ) - - parser.add_argument( - '--rmdirs', - action='store_true', - default=False, - help="""\ - DELETE empty directories after processing. Only valid in - conjunction with `--move`. - """, - ) - - parser.add_argument( - '--output_prefix', - type=str, - default='', - help="""\ - String to prepend to the output directory to aid in sorting - files by an additional level prior to sorting by date. This - string will immediately follow the output path and is intended - to allow runtime setting of the output path (e.g. via $USER, - $HOSTNAME, %%USERNAME%%, etc.) - """, - ) - - parser.add_argument( - '--output_suffix', - type=str, - default='', - help="""\ - String to append to the destination directory to aid in sorting - files by an additional level after sorting by date. - """, - ) - - parser.add_argument( - '--from-date', - type=str, - default=None, - help="""\ - Limit the operations to the files that are newer than --from-date (inclusive). - The date must be specified in format YYYY-MM-DD. Files with unknown date won't be skipped. - """, - ) - - parser.add_argument( - '--to-date', - type=str, - default=None, - help="""\ - Limit the operations to the files that are older than --to-date (inclusive). - The date must be specified in format YYYY-MM-DD. Files with unknown date won't be skipped. - """, - ) - - return parser.parse_args(args) - - -def setup_logging(options): - """Configure logging.""" - root = logging.getLogger('') - root.setLevel(logging.WARNING) - formatter = logging.Formatter( - '[%(asctime)s] - [%(levelname)s] - %(message)s', '%Y-%m-%d %H:%M:%S') - ch = logging.StreamHandler() - ch.setFormatter(formatter) - root.addHandler(ch) - if not options.quiet ^ options.progress: - logger.setLevel(options.debug and logging.DEBUG or logging.INFO) - else: - logger.setLevel(logging.WARNING) - if options.log: - logfile = os.path.expanduser(options.log) - fh = logging.FileHandler(logfile) - fh.setFormatter(formatter) - logger.addHandler(fh) - logger.debug("Debug logging output enabled.") - logger.debug("Running Phockup version %s", __version__) - - -def main(options): - check_dependencies() - - return Phockup( - options.input_dir, - options.output_dir, - dir_format=options.date, - move=options.move, - link=options.link, - date_regex=options.regex, - original_filenames=options.original_names, - timestamp=options.timestamp, - date_field=options.date_field, - dry_run=options.dry_run, - quiet=options.quiet, - progress=options.progress, - max_depth=options.maxdepth, - file_type=options.file_type, - max_concurrency=options.max_concurrency, - no_date_dir=options.no_date_dir, - skip_unknown=options.skip_unknown, - movedel=options.movedel, - rmdirs=options.rmdirs, - output_prefix=options.output_prefix, - output_suffix=options.output_suffix, - from_date=options.from_date, - to_date=options.to_date - ) - - -if __name__ == '__main__': - try: - options = parse_args() - setup_logging(options) - main(options) - except Exception as e: - logger.warning(e) - sys.exit(1) - except KeyboardInterrupt: - logger.error("Exiting phockup...") - sys.exit(1) - sys.exit(0) +app() diff --git a/phockup/__init__.py b/phockup/__init__.py new file mode 100644 index 0000000..704e687 --- /dev/null +++ b/phockup/__init__.py @@ -0,0 +1,7 @@ +from phockup.phockup import main, parse_args, setup_logging + + +def app(): + options = parse_args() + setup_logging(options) + main(options) diff --git a/src/__init__.py b/phockup/internal/__init__.py similarity index 100% rename from src/__init__.py rename to phockup/internal/__init__.py diff --git a/src/date.py b/phockup/internal/date.py similarity index 100% rename from src/date.py rename to phockup/internal/date.py diff --git a/src/dependency.py b/phockup/internal/dependency.py similarity index 100% rename from src/dependency.py rename to phockup/internal/dependency.py diff --git a/src/exif.py b/phockup/internal/exif.py similarity index 100% rename from src/exif.py rename to phockup/internal/exif.py diff --git a/src/phockup.py b/phockup/internal/phockup.py similarity index 99% rename from src/phockup.py rename to phockup/internal/phockup.py index 5add1cd..8e2c374 100755 --- a/src/phockup.py +++ b/phockup/internal/phockup.py @@ -10,8 +10,8 @@ from tqdm import tqdm -from src.date import Date -from src.exif import Exif +from phockup.internal.date import Date +from phockup.internal.exif import Exif logger = logging.getLogger('phockup') ignored_files = ('.DS_Store', 'Thumbs.db') diff --git a/phockup/phockup.py b/phockup/phockup.py new file mode 100755 index 0000000..058c316 --- /dev/null +++ b/phockup/phockup.py @@ -0,0 +1,424 @@ +#!/usr/bin/env python3 +import argparse +import importlib +import logging +import logging.handlers +import os +import pathlib +import re +import sys +from importlib.metadata import version as get_package_version + +from phockup.internal.date import Date +from phockup.internal.dependency import check_dependencies +from phockup.internal.phockup import Phockup + +PROGRAM_DESCRIPTION = """\ +Media sorting tool to organize photos and videos from your camera in folders by year, \ +month and day. +The software will collect all files from the input directory and copy them to the output +directory without changing the files content. It will only rename the files and place +them in the proper directory for year, month and day. +""" + +DEFAULT_DIR_FORMAT = ['%Y', '%m', '%d'] + +logger = logging.getLogger('phockup') + + +def get_version() -> str: + try: + version = f"v{get_package_version('phockup')}" + except importlib.metadata.PackageNotFoundError: + try: + # Fallback to get version on not packaged version, this work only on python 3.11+ + import tomllib + expected_pyproject_file = pathlib.Path(__file__).parent.parent.joinpath("pyproject.toml") + with open(expected_pyproject_file, "rb") as f: + version = f"v{tomllib.load(f).get('project').get('version')}-not-packaged" + except Exception: + version = "unknown-not-packaged" + return version + + +def parse_args(args=sys.argv[1:]): + parser = argparse.ArgumentParser( + description=PROGRAM_DESCRIPTION, + formatter_class=argparse.RawTextHelpFormatter) + parser.version = get_version() + + parser.add_argument( + '-v', + '--version', + action='version', + ) + + parser.add_argument( + '-d', + '--date', + action='store', + type=Date.parse, + help="""\ +Specify date format for OUTPUTDIR directories. + +You can choose different year format (e.g. 17 instead of 2017) or decide to skip the +day directories and have all photos sorted in year/month. + +Supported formats: + YYYY - 2016, 2017 ... + YY - 16, 17 ... + MM - 07, 08, 09 ... + M - July, August, September ... + m - Jul, Aug, Sept ... + DD - 27, 28, 29 ... (day of month) + DDD - 123, 158, 365 ... (day of year) + U - 00, 01, 53 ... (week of the year, Sunday first day of week) + W - 00, 01, 53 ... (week of the year, Monday first day of week) + +Example: + YYYY/MM/DD -> 2011/07/17 + YYYY/M/DD -> 2011/July/17 + YYYY/m/DD -> 2011/Jul/17 + YY/m-DD -> 11/Jul-17 + YYYY/U -> 2011/30 + YYYY/W -> 2011/28 +""", + ) + + exclusive_group_link_move = parser.add_mutually_exclusive_group() + + exclusive_group_link_move.add_argument( + '-m', + '--move', + action='store_true', + help="""\ + Instead of copying the process will move all files from the INPUTDIR to the OUTPUTDIR. + This is useful when working with a big collection of files and the remaining free space + is not enough to make a copy of the INPUTDIR. + """, + ) + + exclusive_group_link_move.add_argument( + '-l', + '--link', + action='store_true', + help="""\ + Instead of copying the process will make hard links to all files in INPUTDIR and place + them in the OUTPUTDIR. + This is useful when working with working structure and want to create YYYY/MM/DD + structure to point to same files. + """, + ) + + parser.add_argument( + '-o', + '--original-names', + action='store_true', + help="""\ + Organize the files in selected format or using the default year/month/day format but + keep original filenames. + """, + ) + + parser.add_argument( + '-t', + '--timestamp', + action='store_true', + help="""\ + Use the timestamp of the file (last modified date) if there is no EXIF date information. + If the user supplies a regex, it will be used if it finds a match in the filename. + This option is intended as "last resort" since the file modified date may not be + accurate, nevertheless it can be useful if no other date information can be obtained. + """, + ) + + parser.add_argument( + '-y', + '--dry-run', + action='store_true', + help="""\ + Does a trial run with no permanent changes to the filesystem. + So it will not move any files, just shows which changes would be done. + """, + ) + + parser.add_argument( + '-c', + '--max-concurrency', + type=int, + default=1, + choices=range(1, 255), + metavar='1-255', + help="""\ + Sets the level of concurrency for processing files in a directory. + Defaults to 1. Higher values can improve throughput of file operations + """, + ) + + parser.add_argument( + '--maxdepth', + type=int, + default=-1, + choices=range(0, 255), + metavar='1-255', + help="""\ + Descend at most 'maxdepth' levels (a non-negative integer) of directories + """, + ) + + parser.add_argument( + '-r', + '--regex', + action='store', + type=re.compile, + help="""\ + Specify date format for date extraction from filenames if there is no EXIF date + information. + + Example: + {regex} + can be used to extract the date from file names like the following + IMG_27.01.2015-19.20.00.jpg. + """, + ) + + parser.add_argument( + '-f', + '--date-field', + action='store', + help="""\ + Use a custom date extracted from the exif field specified. + To set multiple fields to try in order until finding a valid date, use spaces to + separate fields inside a string. + + Example: + DateTimeOriginal + "DateTimeOriginal CreateDate FileModifyDate" + + These fields are checked by default when this argument is not set: + "SubSecCreateDate SubSecDateTimeOriginal CreateDate DateTimeOriginal" + + To get all date fields available for a file, do: + exiftool -time:all -mimetype -j + """, + ) + + exclusive_group_debug_silent = parser.add_mutually_exclusive_group() + + exclusive_group_debug_silent.add_argument( + '--debug', + action='store_true', + default=False, + help="""\ + Enable debugging. Alternately, set the LOGLEVEL environment variable to DEBUG + """, + ) + + exclusive_group_debug_silent.add_argument( + '--quiet', + action='store_true', + default=False, + help="""\ + Run without output. + """, + ) + + exclusive_group_debug_silent.add_argument( + '--progress', + action='store_true', + default=False, + help="""\ + Run with progressbar output. + """, + ) + + parser.add_argument( + '--log', + action='store', + help="""\ + Specify the output directory where your log file should be exported. + This flag can be used in conjunction with the flag `--quiet` or `--progress`. + """, + ) + + parser.add_argument( + 'input_dir', + metavar='INPUTDIR', + help="""\ + Specify the source directory where your photos are located. + """, + ) + + parser.add_argument( + 'output_dir', + metavar='OUTPUTDIR', + help="""\ + Specify the output directory where your photos should be exported. + """, + ) + + parser.add_argument( + '--file-type', + type=str, + choices=['image', 'video'], + metavar='image|video', + help="""\ + By default, Phockup addresses both image and video files. + If you want to restrict your command to either images or + videos only, use `--file-type=[image|video]`. + """, + ) + + parser.add_argument( + '--no-date-dir', + type=str, + default=Phockup.DEFAULT_NO_DATE_DIRECTORY, + help="""\ + Files without EXIF date information are placed in a directory + named 'unknown' by default. This option overrides that + folder name. e.g. --no-date-dir=misc, --no-date-dir="no date" + """, + ) + + parser.add_argument( + '--skip-unknown', + action='store_true', + default=False, + help="""\ + Ignore files that don't contain valid EXIF data for the criteria specified. + This is useful if you intend to make multiple passes over an input directory + with varying and specific EXIF fields that are note checked by default. + """, + ) + + parser.add_argument( + '--movedel', + action='store_true', + default=False, + help="""\ + DELETE source files which are determined to be duplicates of files + already transferred. Only valid in conjunction with both `--move` + and `--skip-unknown`. + """, + ) + + parser.add_argument( + '--rmdirs', + action='store_true', + default=False, + help="""\ + DELETE empty directories after processing. Only valid in + conjunction with `--move`. + """, + ) + + parser.add_argument( + '--output_prefix', + type=str, + default='', + help="""\ + String to prepend to the output directory to aid in sorting + files by an additional level prior to sorting by date. This + string will immediately follow the output path and is intended + to allow runtime setting of the output path (e.g. via $USER, + $HOSTNAME, %%USERNAME%%, etc.) + """, + ) + + parser.add_argument( + '--output_suffix', + type=str, + default='', + help="""\ + String to append to the destination directory to aid in sorting + files by an additional level after sorting by date. + """, + ) + + parser.add_argument( + '--from-date', + type=str, + default=None, + help="""\ + Limit the operations to the files that are newer than --from-date (inclusive). + The date must be specified in format YYYY-MM-DD. Files with unknown date won't be skipped. + """, + ) + + parser.add_argument( + '--to-date', + type=str, + default=None, + help="""\ + Limit the operations to the files that are older than --to-date (inclusive). + The date must be specified in format YYYY-MM-DD. Files with unknown date won't be skipped. + """, + ) + + return parser.parse_args(args) + + +def setup_logging(options): + """Configure logging.""" + root = logging.getLogger('') + root.setLevel(logging.WARNING) + formatter = logging.Formatter( + '[%(asctime)s] - [%(levelname)s] - %(message)s', '%Y-%m-%d %H:%M:%S') + ch = logging.StreamHandler() + ch.setFormatter(formatter) + root.addHandler(ch) + if not options.quiet ^ options.progress: + logger.setLevel(options.debug and logging.DEBUG or logging.INFO) + else: + logger.setLevel(logging.WARNING) + if options.log: + logfile = os.path.expanduser(options.log) + fh = logging.FileHandler(logfile) + fh.setFormatter(formatter) + logger.addHandler(fh) + logger.debug("Debug logging output enabled.") + logger.debug("Running Phockup version %s", get_version()) + + +def main(options): + check_dependencies() + + return Phockup( + options.input_dir, + options.output_dir, + dir_format=options.date, + move=options.move, + link=options.link, + date_regex=options.regex, + original_filenames=options.original_names, + timestamp=options.timestamp, + date_field=options.date_field, + dry_run=options.dry_run, + quiet=options.quiet, + progress=options.progress, + max_depth=options.maxdepth, + file_type=options.file_type, + max_concurrency=options.max_concurrency, + no_date_dir=options.no_date_dir, + skip_unknown=options.skip_unknown, + movedel=options.movedel, + rmdirs=options.rmdirs, + output_prefix=options.output_prefix, + output_suffix=options.output_suffix, + from_date=options.from_date, + to_date=options.to_date + ) + + +if __name__ == '__main__': + try: + options = parse_args() + setup_logging(options) + main(options) + except Exception as e: + logger.warning(e) + sys.exit(1) + except KeyboardInterrupt: + logger.error("Exiting phockup...") + sys.exit(1) + sys.exit(0) diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..59a8ef5 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,36 @@ +[project] +name = "phockup" +version = "1.13.0" +description = "Media sorting tool to organize photos and videos from your camera in folders by year, month and day" +authors = [ + { name = "Ivan Dokov", email = "ivan@jetspark.io" } +] +dependencies = [ + "tqdm" +] +readme = "readme.md" +requires-python = ">= 3.8" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[tool.rye] +universal = true +managed = true +dev-dependencies = [ + "pytest>=8.3.3", + "pytest-mock", + "pytest-cov", + "pytest-socket", + "pre-commit", +] + +[tool.hatch.metadata] +allow-direct-references = true + +[project.scripts] +phockup = 'phockup:app' + +[tool.ruff.lint] +ignore = ["E203", "E501", "W503", "E126"] diff --git a/readme.md b/readme.md index 3202ffa..fc62056 100644 --- a/readme.md +++ b/readme.md @@ -67,7 +67,7 @@ curl -L https://github.com/ivandokov/phockup/archive/latest.tar.gz -o phockup.ta tar -zxf phockup.tar.gz sudo mv phockup-* /opt/phockup cd /opt/phockup -pip3 install -r requirements.txt +pip3 install -r requirements.lock sudo ln -s /opt/phockup/phockup.py /usr/local/bin/phockup ``` @@ -328,11 +328,33 @@ operations to complete before shutting down. ## Development -### Running tests +### Use rye + +This project now use [Rye](https://rye.astral.sh/) +to start with the project: + +```shell +rye sync +``` + +to test : + +```shell +rye test +``` + +to build python package (both sdist and wheel): + +```shell +rye build +``` + +### Running tests [legacy method] To run the tests, first install the dev dependencies using ```bash -pip3 install -r requirements-dev.txt +pip3 install -r requirements.lock +pip3 install -r requirements-dev.lock ``` Then run the tests using diff --git a/requirements-dev.lock b/requirements-dev.lock new file mode 100644 index 0000000..40d2023 --- /dev/null +++ b/requirements-dev.lock @@ -0,0 +1,54 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: false +# with-sources: false +# generate-hashes: false +# universal: true + +-e file:. +cfgv==3.4.0 + # via pre-commit +colorama==0.4.6 ; sys_platform == 'win32' or platform_system == 'Windows' + # via pytest + # via tqdm +coverage==7.6.1 + # via pytest-cov +distlib==0.3.8 + # via virtualenv +exceptiongroup==1.2.2 ; python_full_version < '3.11' + # via pytest +filelock==3.16.0 + # via virtualenv +identify==2.6.0 + # via pre-commit +iniconfig==2.0.0 + # via pytest +nodeenv==1.9.1 + # via pre-commit +packaging==24.1 + # via pytest +platformdirs==4.3.2 + # via virtualenv +pluggy==1.5.0 + # via pytest +pre-commit==3.5.0 +pytest==8.3.3 + # via pytest-cov + # via pytest-mock + # via pytest-socket +pytest-cov==5.0.0 +pytest-mock==3.14.0 +pytest-socket==0.7.0 +pyyaml==6.0.2 + # via pre-commit +tomli==2.0.1 ; python_full_version <= '3.11' + # via coverage + # via pytest +tqdm==4.66.5 + # via phockup +virtualenv==20.26.4 + # via pre-commit diff --git a/requirements-dev.txt b/requirements-dev.txt deleted file mode 100644 index 4ea7340..0000000 --- a/requirements-dev.txt +++ /dev/null @@ -1,6 +0,0 @@ --r requirements.txt -pytest -pytest-mock -pytest-cov -pytest-socket -pre-commit diff --git a/requirements.lock b/requirements.lock new file mode 100644 index 0000000..2f7bf81 --- /dev/null +++ b/requirements.lock @@ -0,0 +1,16 @@ +# generated by rye +# use `rye lock` or `rye sync` to update this lockfile +# +# last locked with the following flags: +# pre: false +# features: [] +# all-features: false +# with-sources: false +# generate-hashes: false +# universal: true + +-e file:. +colorama==0.4.6 ; platform_system == 'Windows' + # via tqdm +tqdm==4.66.5 + # via phockup diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index ae3df91..0000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -tqdm==4.66.1 diff --git a/snapcraft.yaml b/snapcraft.yaml index 703adc5..077d9ed 100644 --- a/snapcraft.yaml +++ b/snapcraft.yaml @@ -8,7 +8,6 @@ description: | Media sorting tool to organize photos and videos from your camera in folders by year, month and day. The software will collect all files from the input directory and copy them to the output directory without changing the files content. It will only rename the files and place them in the proper directory for year, month and day. - apps: phockup: command: phockup.sh @@ -20,7 +19,7 @@ parts: source: . override-pull: | snapcraftctl pull - snapcraftctl set-version `cat phockup.py | grep '__version__ = ' | sed "s/.*'\(.*\)'/\1/"` + snapcraftctl set-version `cat pyproject.toml | grep 'version = ' | sed "s/.*'\(.*\)'/\1/"` files: plugin: dump diff --git a/tests/test_date.py b/tests/test_date.py index 6a027d6..ac0f7b6 100644 --- a/tests/test_date.py +++ b/tests/test_date.py @@ -3,7 +3,7 @@ import re from datetime import datetime -from src.date import Date +from phockup.internal.date import Date os.chdir(os.path.dirname(__file__)) diff --git a/tests/test_exif.py b/tests/test_exif.py index c625904..b4640a2 100644 --- a/tests/test_exif.py +++ b/tests/test_exif.py @@ -2,7 +2,7 @@ import os from subprocess import CalledProcessError -from src.exif import Exif +from phockup.internal.exif import Exif os.chdir(os.path.dirname(__file__)) diff --git a/tests/test_phockup.py b/tests/test_phockup.py index 0c634a6..ed2c5b7 100644 --- a/tests/test_phockup.py +++ b/tests/test_phockup.py @@ -7,9 +7,9 @@ import pytest -from src.dependency import check_dependencies -from src.exif import Exif -from src.phockup import Phockup +from phockup.internal.dependency import check_dependencies +from phockup.internal.exif import Exif +from phockup.internal.phockup import Phockup os.chdir(os.path.dirname(__file__)) diff --git a/tox.ini b/tox.ini deleted file mode 100644 index ce9c9d5..0000000 --- a/tox.ini +++ /dev/null @@ -1,3 +0,0 @@ -[flake8] -max-line-length = 88 -ignore = E203 E501 W503 E126