Giter VIP home page Giter VIP logo

autotransferx's Introduction

Forks Stargazers Issues MIT License


Logo

AutoTransferX


AutoTransfer is a lightweight and easy-to-use program designed to automatically transfer files between folders based on their file extension. Simply specify a source folder to watch and a destination folder to transfer files to, and AutoTransfer will do the rest. With support for multiple file extensions and the ability to customize transfer settings, AutoTransfer makes it easy to manage and organize your files without manual intervention. Whether you're a developer looking to automate file transfers for a project or a user looking to simplify your file management process, AutoTransfer is the perfect solution.
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

Features:

  • Automatically transfer files based on their extension
  • Watch a folder and transfer files as soon as they are added
  • Support for any file extension
  • Customize transfer settings, including file overwrite rules and file renaming options
  • Lightweight and easy-to-use CLI
  • Cross-platform compatibility (macOS, Linux)
  • Open-source and free to use

![Product Name Screen Shot][product-screenshot]

(back to top)

Getting Started

Make sure to have Python installed on your device, then, to get a local copy up and running follow these steps.

Installation

  1. Clone the repo

    git clone https://github.com/theblackcat98/AutoTransferX.git
  2. Open main.py, and follow the CLI to create your first folder pair!

    ./main.py

(back to top)

Usage

The specified watch folder is the Downloads folder, and the Documents folder as the destination folder to transfer files to. The user has also specified two different file extensions to watch for - ".pdf" and ".docx".

When a new file with one of these extensions is added to the Downloads folder, AutoTransfer automatically transfers it to the corresponding subfolder in the Documents folder. For example, a new PDF file is transferred to the Documents/PDFs folder, and a new Word document is transferred to the Documents/Word Docs folder. This saves the user time and effort by organizing their files automatically based on their file type.

For more examples, please refer to the Documentation (todo)

(back to top)

Roadmap

  • Customize transfer settings
    • Regex support
    • File overwrite rules
    • File renaming options
  • Folder Pair Database
    • folder_pair_db.json: Json file to store and manipulate the folder pairs' settings, names, info etc.
  • Better GUI
  • Packaging
    • .exe App
    • .dmg App
    • Linux??

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

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

(back to top)

Contact

Your Name - email@email_client.com

Project Link: https://github.com/theblackcat98/AutoTransferX

(back to top)

App Layout

GUI

gui.py: Contains the main GUI class FileTransferGUI with methods for displaying the UI elements and handling user events.

File Transfer

file_transfer.py: Contains the FileTransfer class that handles the file transfer functionality.

Logging

logger.py: Contains the Logger class that handles logging of events.

Utility

utils.py: Contains any utility functions that are needed across multiple modules.

Main

main.py: The main entry point of the application, where the classes and modules are instantiated and executed.

autotransferx's People

Contributors

theblackcat98 avatar rift7 avatar

Watchers

 avatar

Forkers

rift7

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.