Metadata-Version: 2.1
Name: move-my-files
Version: 0.2.1
Summary: CLI tools to organize files on your computer
Home-page: https://github.com/jan25/move-my-files
Author: Abhilash Gnan
Author-email: abhilashgnan@gmail.com
License: UNKNOWN
Description: # move-my-files
        
        `mmf` is a cli tool for organising files on your computer. Tell it the file name patterns, where to move and matching files from a source directory are moved to target directory. Run it as one-off command or in watch mode to continously observe a source directory.
        
        ## Installation
        
        Prerequisites:
        
        - Python >=3.5
        - `pip` package manager
        
        Install `mmf` using:
        
        ```sh
        # Install or upgrade mmf
        pip install move-my-files -U
        ```
        
        ## Usage
        
        Move files using either one time command or watch mode:
        
        ```sh
        # Supply source and destination directory explicitly
        mmf move --source ~/Documents --dest-dir ~/Documents/images --pattern .png
        
        # Uses predefined configuration(provided in using add command)
        mmf move --source ~/Documents
        
        # Watch ~/Documents directory for moving files
        mmf move --source ~/Documents --dest-dir ~/Documents/images --pattern .png --watch
        mmf move --source ~/Documents --watch
        ```
        
        Define your favorite configurations using `add` command. This command keeps track of your configurations so they are not required to be typed in future. Use `list` command to list configurations you've previosly added.
        
        ```sh
        # Add configuration
        mmf add --dest-dir ~/Documents/images --pattern .png
        mmf add --dest-dir ~/Documents/pyfiles --pattern .py
        
        # List configurations (previously added)
        mmf list
        
        # move without --dest-dir will use configurations
        mmf move --source ~/Documents --watch
        ```
        
        Available shortcuts for options:
        
        - `--source`: `-s`
        - `--dest-dir`: `-d`
        - `--pattern`: `-p`
        - `--watch`: `-w`
        
        ## Develop
        
        Fork and clone this repository to develop on latest master branch. General steps to execute python code form this repo:
        
        ```sh
        # Create development environment
        cd /move-my-files
        virtualenv .env && source .env/bin/activate
        python3 setup.py install
        
        # Execute CLI (from code)
        python3 .
        python3 . list
        ```
        
        Local testing with unit tests and CLI:
        
        ```sh
        # Run available unit tests
        python3 -m pytest tests -v
        
        # Install CLI locally to test (basically testing setup.py)
        python install -e .
        mmf
        ```
        
        For Packaging and publishing see here:
        
        - https://packaging.python.org/guides/distributing-packages-using-setuptools
        
        If you have ideas to improve this tool, feel free to raise a new issue in the Issues section or open a PR :)
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
