Skip to main content

Python timer module for humans.

Project description

Simple python module for mark time.

Inspired by two functions from node.js:

Main features:

  • easy to use

  • no external dependencies

  • 100% test coverage

  • works with Python 2.7 and 3.3

Usage

$ pip install marktime
import marktime

marktime.start('some task')
marktime.start('some another task')

marktime.stop('some task')
8.757422924041748

marktime.stop('some another task')
14.805735111236572

marktime.duration('some another task')
14.805735111236572

marktime.start('some task # 3')

import json
print json.dumps(marktime.labels, indent=4)
{
    'some another task': {
        'duration': 14.805735111236572,
        'start_time': 1370453758.064955,
        'end_time': 1370453772.87069
    },

    'some task # 3': {
        'start_time': 1370453892.025603,
        'end_time': None
    },

    'some task': {
        'duration': 8.757422924041748,
        'start_time': 1370453753.185846,
        'end_time': 1370453761.943269
    }
}

API

  • marktime.start (label, at=None)

    • label — marker label. String. Required.

    • at — time to start the countdown. If None then uses time.time().

  • marktime.stop (label, remove_from_labels=False, stop_once=True)

    • label — marker label. String. Required.

    • at — time to stop the countdown. If None then uses time.time()

    • remove_from_labels — if True then label removed from global dict marktime.labels.

    • stop_once — if False and the countdown for the certain label is allready stopped thet it stopped it again. And thereafter the duration for the certain label will be increased.

  • marktime.duration (label, stop_it=True, stop_at=None)

    • label — marker label. String. Required.

    • stop_it — if True then the countdown for the certain label will be stopped. If False and the countdown for the certain label is not stopped then returns None.

    • stop_at — passed into stop function if stop_it == True

  • marktime.labels — global dict that stores all the labels for time markers.

License

See LICENSE 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

marktime-0.1.1.tar.gz (2.9 kB view hashes)

Uploaded Source

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