Skip to main content

A simple automated task to schedule files to open in specific days of the week or every day at startup or at specific time of the day.

Project description

Downloads

Program Scheduler

A simple way of scheduling files at startup or at specific time of the day. The file can also be scheduled to start at specific days of the week or every day.

Table of Contents

Description

The current project provides a simple automated task to schedule files to open in specific days of the week or every day at startup or at specific time of the day. Multiple files can be scheduled.

For the progscheduler to work as intended, the startup feature includes having to add a file containing the command for starting the progscheduler in a specific startup folder for Windows users. If that's not done, then the progscheduler continues to work fine but to have the scheduled files to open, the user must run the progscheduler manually every time. If the 'program-scheduler.bat' exists, double-click this file to start running the program. This is explained in here.

A scheduled file can also be any type of file including folders. See Notes.

Features

Status Features
schedule a file to start/open at specific days of the week or everyday
schedule a file to start/open at specific time of the day
schedule a file to start/open when the computer boots up
configuration of multiple files to schedule
see current configurations

Any new features are very welcomed.

Future features

  • Currently, the progscheduler only starts/opens a file, but in the future, a file can also be configured to do other types of jobs.

Done ✅

  • Currently, the progscheduler never stops running the scheduler, but it can be implemented that if all scheduled jobs are at startup, and they already finished then the progscheduler could stop automatically until manually started or computer rebooted.

Any unimplemented features will be developed by user request, so if you want any of these or new ones, open an issue.

Prerequisites

Python 3 must be installed.

Installation

pip --no-cache-dir install progscheduler

or,

pip3 --no-cache-dir install progscheduler

Windows users

To enable the startup feature, the file 'program-scheduler.bat' is provided. This file can be found in this project's github repository.

The 'program-scheduler.bat' needs to be put into

C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup 

folder to start running when the computer boots up.

This will open a command prompt window automatically when the computer boots up. This window should only be closed if all desired jobs are already finished.

Linux Users

Open an issue if you need to know how to enable this feature in Linux.

Usage

Command Type Description
--run REQUIRED for the scheduler to run if specified, the scheduler will start running using user-defined configurations.
-a REQUIRED to create new scheduled job file alias. this name is UNIQUE within all scheduled files. to create or update any configuration regarding a specific file, this is required.
-p REQUIRED to create new scheduled job absolute path of file to schedule (including the extension name except for folders).
-d REQUIRED to create new scheduled job days to schedule a file within the following options: 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday', 'everyday', 'weekdays' and 'weekends'.
-t OPTIONAL specific time to start/open a file. default is '' (empty). if time is empty then the file will start when the progscheduler command is run (at startup if program-scheduler.bat file was configured).
-ts OPTIONAL define a time for a specific scheduled job to stop running if progscheduler runs.
-del OPTIONAL delete a existing configuration with the file alias.
-ls OPTIONAL list all global settings.
-lsch OPTIONAL list all scheduled jobs.

Important

  • -a command is always required when configuring.
  • -p, -d command is required only the first time to configure a file to schedule.
  • If the file is an executable file, it's recommended to input the absolute path to a shortcut instead of the original file location because if so, the executable file may not start at all. If a shortcut is used, the extension '.lnk' is needed. For instance: 'C:\Users<!username>\Desktop\ExecutableShortcutWithEXEExtension.lnk'

Notes

  • By 'file', it means that the progscheduler can schedule executable files, text files, folders, or any type of file to start/open.
  • If a specific time is set, the file will only start/open from the moment the progscheduler starts running. Meaning if a file is scheduled to start at 08:00 and the progscheduler only starts running at 08:30, then the next time the file will start is at 08:00 the next day (if the progscheduler is running).
  • If a file needs to be scheduled using mixed configurations, for instance, a folder needs to be opened at startup on monday but on 08:15 on friday, then the same file can be configured but always using different file alias.

Any additional help can be provided if the following command is run:

progscheduler --help

or,

progscheduler -h

Before running the scheduler, at least one program needs to be configured. The following command will configure the 'program.exe' to start when the computer boots up every monday, friday and saturday

progscheduler -a ThisNAmeRefersToCurrentProgramToSchedule -p "C:\Users\<username>\Desktop\program.exe" -d monday friday saturday

To configure an existing program to change days to schedule:

progscheduler -a ThisNAmeRefersToCurrentProgramToSchedule -d everyday

To configure an existing program to change time to schedule. The following command would schedule a program to start every day and at 08:00:

progscheduler -a ThisNAmeRefersToCurrentProgramToSchedule -t "08:00"

To delete an existing configuration:

progscheduler -del ThisNAmeRefersToCurrentProgramToSchedule

When all desired files are scheduled in the configurations, the following command will run the scheduler considering every configuration made:

progscheduler --run

Once the progscheduler starts running it will not stop alone, to cancel just run CTRL + C or close the terminal window. The exception to this is if the 'exit-when-done' is enabled.

Support

If any problems occurs, feel free to open an issue.

License

MIT

Status

This project was developed for both need and educational purposes, so I'm available to maintain this project, so any bugs, suggestions, new features, improvements, etc, don't hesitate to ask, open an issue or a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

progscheduler-2.1.1.tar.gz (13.3 kB view details)

Uploaded Source

Built Distributions

progscheduler-2.1.1-py3.11.egg (31.7 kB view details)

Uploaded Source

progscheduler-2.1.1-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file progscheduler-2.1.1.tar.gz.

File metadata

  • Download URL: progscheduler-2.1.1.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for progscheduler-2.1.1.tar.gz
Algorithm Hash digest
SHA256 1332bdc1c90cfa57f3334fa02dbf8a64b0fb43d03f679dd0d7840b8d7705aa31
MD5 2602a2f6ab0586c2cc41b2130a69dc45
BLAKE2b-256 db1c7c4d868a8009fab6cc0463fc6cf322a0698bab929c540f73583da5e388ad

See more details on using hashes here.

File details

Details for the file progscheduler-2.1.1-py3.11.egg.

File metadata

  • Download URL: progscheduler-2.1.1-py3.11.egg
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for progscheduler-2.1.1-py3.11.egg
Algorithm Hash digest
SHA256 b6fdca45573e9139ecb38f58f08368e37f54ec61b977fedba9a1cd9838f66ba2
MD5 0a465aaaefe07833c1d2d386ed4cc674
BLAKE2b-256 dccff4dcc136b443bae1947bbf51302ce4f7a4a70008e3a7913a3b2e331423c9

See more details on using hashes here.

File details

Details for the file progscheduler-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for progscheduler-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ca5109f01b4f303233251395d74eed3f0552aa898017ecdc39b94e9a447c5e0
MD5 5961ebfb6eaad0e27dc2a411c714cdfb
BLAKE2b-256 d25dd66768cc2541b19faeb50d9830669ad2533b2650a5521e9db9866e606119

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page