/pysmb-file-sorter

A file sorter using pysmb

Primary LanguagePythonMIT LicenseMIT

pysmb-file-sorter

A script to organize files by year, month, and date on a smb server.

Table of Contents

1. Change Log

2. How To Setup & Run

3. How It Works

4. Dependencies

Change Log

To be updated...

How To Setup & Run

Installing Required Modules

Use to install required modules:

pip install -r requirements.txt

when cloning the repository, requirements.txt should be in the base directory of the project, if this does not work you may need to reference the path to the requirements file i.e /downloads/pysmb-file-sorter/requirements.txt

If you don't have pip or your system cannot run the command try, you will need to use pip3 instead if this is not an option then you will need to install either pip or pip3:

pip3 install -r requirements.txt

when cloning the repository, requirements.txt should be in the base directory of the project, if this does not work you may need to reference the path to the requirements file i.e /downloads/pysmb-file-sorter/requirements.txt

Creating & Setting Up The Config File

I purposefully have not added the configs file I use. However I will explain how to set it up to start with.

Steps To Create Config File

  1. Create a new configs file in the same folder as the script file and name it smb-configs.json.

If you want to put this in a configs folder, you will want to change the write_config(data) and the read_config() functions.

  1. The layout should consist of this
{
    "profiles":[],
    "ignored-directories":[],
    "output-directory":"",
    "valid-extensions":[]
}
  1. Add your credentials to the config for example:
{
    "profiles":[],
    "ignored-directories":[],
    "output-directory":"/path/to/move/files/to",
    "valid-extensions":[".jpg",".JPG",".png",".PNG"]
}

Path Information For Config

This script needs a folder to move the files to. This needs to be the exact path on the drive, it also needs the parent directory to be the same as your indicated "SHARE_NAME".

Example 1

Take this as the config file example:

{
         "profiles":
         [
            {
            "SERVER_NAME": "smbserver",
            "USERNAME": "user1",
            "PASSWORD": "password",
            "DOMAIN": "smbserver",
            "SHARE_NAME": "main/smbserver"
            }
        ],
        "output-directory":"Sorted"
}

The SHARE_NAME is the SHARE folder, and the output-directory is a folder called "Sorted" in the share path so this would look like : smb://smbserver/main/smbserver/Sorted as a file link.

Example 2

Take this as the config file example:

{
         "profiles":
         [
            {
            "SERVER_NAME": "server",
            "USERNAME": "user1",
            "PASSWORD": "password",
            "DOMAIN": "192.168.1.229",
            "SHARE_NAME": "james"
            }
        ],
        "output-directory":"Sorted"
}

The SHARE_NAME is the SHARE folder, and the output-directory is a folder called "Sorted" in the share path so this would look like : smb://192.168.1.229/james/Sorted as a file link.

Server Profiles

A profile consists of a:

  • SERVER_NAME
  • USERNAME
  • PASSWORD
  • DOMAIN
  • SHARE_NAME

- SERVER_NAME

The server name is dictated as what the machine name or network name of the machine is.

For example my raspberry pi comes under it's IP which also is linked to the DOMAIN. But my truenas server it's SHARE_NAME is truenas but it can be accessed by it's IP or the term truenas in it's DOMAIN so you may have to play about with the different options.

- USERNAME

This has to be a user to the machine, this could be a root user or if it's a user specific to the share.

- PASSWORD

This is the password that you will use with the USERNAME to login to that Share.

- DOMAIN

This is the server address that it will need to connect to it, wether this is the IP of the machine or the actual smb address like I mentioned in SERVER_NAME

- SHARE_NAME

This is the name/display name of the Share folder.

For example in smbd.config you may have a share called James but it could be linked to a folder called smbserver/James-Share the SHARE_NAME may look like this "SHARE_NAME":"James:"

SERVER_NAME & DOMAIN when it is the IP should look like this:

{
    "SERVER_NAME": "127.0.0.1",
    "USERNAME": "testuser",
    "PASSWORD": "pysmbtestuser",
    "DOMAIN": "127.0.0.1",
    "SHARE_NAME": "TESTSHARE"
}

How It Works

I initially didn't know where to start with this and had a lot of thinking to do.

It's still being worked on as of "Aug 7 2024"

So when the script is ran it will try to find the config file. It will then strip the information to the different parts. It needs a server profile to connect to first, so there's the option to create a new one or select an already existing one.

Once a profile is chosen, I attempt a connection, if it fails I prompt the user with the error message that the connection was broken and they need to try again. If successful, it will then check if there is an output directory corelating to the one in the config file. If it doesn't exist it creates a new folder.

Next it will then loop through the path given, it's a deep first search on the subject of folders.

For Example:

graph TD;
    A-->B;
    A-->C;
    B-->D;
    B-->E;
    E-->F;
    F-->G;
    C-->H;
    H-->I;
    H-->J;
Loading

  • Node A is our root node for example Sorted in this URL: smb://smbserver/main/smbserver/Sorted

  • My algorithm will search all files, if the file matches to the conditions it will be moved however if it's a folder it will search it and keep going down it.

  • It will then back out and carry on from where it left off in the parent node to the child you wer last in.

Finally the program clears up any empty folders that it has left

As of 7th of August 2024 this feature does not exist and is under design and development

Contributing

There are different ways you can contribute and help me develop this. You can:

  • Suggest features
  • Help with issues
  • Test and try to break and create issues highlighting bugs
  • Share With Friends!

Suggesting features

If you can think of ways to improve, create an issue on the Issues page following the pre-created template. If this is a solid feature I will create a branch for it and keep the issue open until obviously it is completed to satisfaction.

Help with issues

I am the creator and as of now the only contributor, if you can help in any way the help is there. The way the repo is laid out is as so. There are 3 branches

  • main
  • test
  • dev

With each issue, a new branch will be created for each issue. If you add anything as in say you finish a function or change a function, commit this to the branch. Then at the end of a coding session, or when finish with your idea create a pull request to merge you changes into DEV.

Finally when the issue is to satisfaction a new pull request needs to be made to merge the issue branch into TEST, this pull request needs to be tagged as needs testing and link the original issue in the pull request with the changes and any removals, including any dependencies that are added or removed wether they be 3rd party or library dependencies.

Dependencies

3rd Party

  • pysmb package is used for connecting and using the rename method to "move" files.

Lib Packages