Added a decorator

[RHagenaars]

I've added a decorator for conveniently defining jobs from functions.

[Naramsim]

Can you write pls how to use this decorator?

Thanks

[dbader]

Thanks RHagenaars for creating this PR. To tell you the truth I'm on the fence whether this should be a part of schedule itself or an FAQ item.

A couple of thoughts here:

• Please use functools.wraps to ensure the metadata of the wrapped function is copied over.
• The code example doesn't import repeat()
• I don't think the code example will render correctly in the HTML docs, this would also need fixing.

[RHagenaars]

@Naramsim the usage would be as follows:

@repeat(every(10).minutes)
def f():
  print('This function is repeated.')

@dbader thanks for taking time to consider it. About your thoughts:

Please use functools.wraps to ensure the metadata of the wrapped function is copied over.

That's not necessary in this case. If you look closely, you'll see that the actual decorated function is returned and not some wrapper.

The code example doesn't import repeat()

Good catch! I've added that import.

I don't think the code example will render correctly in the HTML docs, this would also need fixing.

I'm not sure how to fix that. Could you elaborate some more on what exactly needs to be fixed? I took the docstring on top of the file for an example.

I'm on the fence whether this should be a part of schedule itself or an FAQ item

That's up to you of course. I personally like decorators for things like this, because it allows you to put coupled statements - the function and the schedule - close to each other. I think that in most cases, the code is more clear when these are not separated.

[coveralls]

Coverage remained the same at 100.0% when pulling 237593f on RHagenaars:master into cc994b3 on dbader:master.

[SijmenHuizenga]

Hi @RHagenaars, Thanks a lot for submitting this pr! I'm thrilled to add this to the library 💯

Just now I've added support for passing arguments to the function via the decorator. And I've added some examples to the docs. Would you like to let me know what you think of this?

[RHagenaars]

Looks good to me, @SijmenHuizenga ! I really like the addition of passing arguments.

[SijmenHuizenga]

Thanks for the review @RHagenaars! Let's merge 🚀