Skip to main content

Stores progress in a file, useful for idempotent multi-step processes.

Project description


This module is for keeping track of progress. It's useful for idempotent multi-part processes. If a process is interrupted or quits unexpectantly this can be used to keep track of the progress so that the next time the process is run, it can pick up where it left off.


pip install progress_keeper


To create a progress object you need to define the following args:

  • fp (str): file path of file to save progress into
  • vars (list(str), optional): list of variables to include in progress file and keep track of. If undefined then it will assume only one var and use the default name - 'last_index_processed'.

When you create a progress object the module will check if the 'fp' exists and either use the values in that file if it does exist or create a new file (and set progress values to 0) if it does not exist.

fp = 'tmp/my-progress.cfg'
vars = ['process_abc','sub_process_a']

# create progress object
progress = Progress(fp, vars)

# increment progress 'var' by 1

# get value of progress 'var'

# reset value of progress

# delete progress file

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

progress_keeper-0.1.5.tar.gz (2.8 kB view hashes)

Uploaded source

Built Distribution

progress_keeper-0.1.5-py3-none-any.whl (4.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page