Skip to content

Latest commit

 

History

History
160 lines (125 loc) · 4.26 KB

README.md

File metadata and controls

160 lines (125 loc) · 4.26 KB
Raw

Files Organizer

It's a great tool to organize your photos, videos, documents, etc based on their date. When you run the tool, all the files in the current directory will be moved to the corresponding folders organized by month and year.
⚠️ Linux limitation: If the file doesn't have a date on it's name, it's not possible to get the file creation date, so the last modified date will be used instead. ⚠️

Explore the docs »
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Features

  • It has 4 ways to identify the files date
  • Cross-platform (Windows, Mac, Linux)
  • Do a backup by default
  • Organize files in folders created by month and year (like 2022-01)

Built With

  • Python3 - A general-purpose, high-level programming language
  • fire - A google library for creating CLI applications

Getting Started

You can install the tool from PyPI or directly from GitHub. You just need to have Python3 installed.

PyPI Installation

  • Windows: 
    pip3 install files-organizer[win]
  • Mac or Linux: 
    pip3 install files-organizer

GitHub Installation

  1. Clone the repo
git clone https://github.com/xandao-dev/files-organizer.git
  1. Install the tool
cd files-organizer
python3 setup.py install
  1. (Windows Only) Install Dependencies
python3 -m pip install pywin32

Usage

  • Run the tool on the current directory and do a backup 
    files-organizer
  • Run the tool on the current directory without backup 
    files-organizer --no-backup
  • Run the tool specifying the path and do a backup 
    files-organizer --path=path/to/directory
  • Run the tool specifying the path without backup 
    files-organizer --path=path/to/directory --no-backup
  • Show the help 
    files-organizer --help

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Free software =)

Contact

Alexandre Calil - Linkedin - [email protected]

Project Link: https://github.com/xandao-dev/files-organizer