Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xandao-dev/files-organizer
Organize files by date, creating a folder for each month
https://github.com/xandao-dev/files-organizer
files filesystem organize-media-files organize-photos organizer python python3
Last synced: 3 months ago
JSON representation
Organize files by date, creating a folder for each month
- Host: GitHub
- URL: https://github.com/xandao-dev/files-organizer
- Owner: xandao-dev
- License: mit
- Created: 2022-01-21T17:59:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-06T01:42:55.000Z (over 2 years ago)
- Last Synced: 2024-10-10T12:50:42.563Z (3 months ago)
- Topics: files, filesystem, organize-media-files, organize-photos, organizer, python, python3
- Language: Python
- Homepage:
- Size: 186 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
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.
:warning: 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. :warning:
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
## 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](https://www.python.org/) - A general-purpose, high-level programming language
* [fire](https://github.com/google/python-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:
```sh
pip3 install files-organizer[win]
```
* Mac or Linux:
```sh
pip3 install files-organizer
```
### GitHub Installation
1. Clone the repo
```sh
git clone https://github.com/xandao-dev/files-organizer.git
```
2. Install the tool
```sh
cd files-organizer
python3 setup.py install
```
3. (Windows Only) Install Dependencies
```sh
python3 -m pip install pywin32
```
## Usage
* Run the tool on the current directory and do a backup
```sh
files-organizer
```
* Run the tool on the current directory without backup
```sh
files-organizer --no-backup
```
* Run the tool specifying the path and do a backup
```sh
files-organizer --path=path/to/directory
```
* Run the tool specifying the path without backup
```sh
files-organizer --path=path/to/directory --no-backup
```
* Show the help
```sh
files-organizer --help
```
## Roadmap
See the [open issues](https://github.com/xandao-dev/files-organizer/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](./LICENSE.md) for more information.
Free software =)
## Contact
Alexandre Calil - [Linkedin](https://www.linkedin.com/in/xandao-dev/) - [[email protected]](mailto:[email protected])
Project Link: [https://github.com/xandao-dev/files-organizer](https://github.com/xandao-dev/files-organizer)