https://github.com/rightlag/timely

Manage the uptime of AWS EC2 containers
https://github.com/rightlag/timely

Last synced: 5 days ago
JSON representation

Manage the uptime of AWS EC2 containers

• Host: GitHub
• URL: https://github.com/rightlag/timely
• Owner: rightlag
• License: mit
• Created: 2015-09-02T18:04:26.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:15:06.000Z (almost 2 years ago)
• Last Synced: 2024-10-07T04:43:18.318Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# timely [![Travis](https://img.shields.io/travis/rightlag/timely.svg?style=flat-square)](https://travis-ci.org/rightlag/timely) [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg?style=flat-square)](https://www.python.org/dev/peps/pep-0008/)

timely 0.2.0

Released: 2-Sep-2015

# Introduction

timely is a Python package that allows users to manage the uptime of their [Amazon Web Services](https://aws.amazon.com/) EC2 containers by providing times at which the containers should be running for any day of the week.

# Requirements

timely requires an `AWS_ACCESS_KEY_ID` and an `AWS_SECRET_ACCESS_KEY`. These can be configured by either exporting [environment variables](https://github.com/boto/boto#getting-started-with-boto) or creating a `~/.boto` [configuration file](https://boto.readthedocs.org/en/latest/getting_started.html#configuring-boto-credentials).

All commits are tested with [Travis CI](https://travis-ci.org/) and *also* require the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables to be set.

# Code Samples

### Fetch all containers and their times

```python

>>> from timely import Timely

>>> timely = Timely()

>>> print(timely.all())

{u'i-6dc5bc92': [Time(weekday='Monday', start_time=datetime.time(9, 0, tzinfo=), end_time=datetime.time(17, 0, tzinfo=))]}

```

### Set times for all containers during certain days of the week

```python

>>> from timely import Timely

>>> from datetime import time

>>> timely = Timely()

>>> t1 = time(9, 0)

>>> t2 = time(17, 0)

>>> timely.set(t1, t2, weekdays=['Monday'])

```

### Check if containers should be running

```python

>>> from timely import Timely

>>> timely = Timely(verbose=True)

>>> timely.check()

starting instance: i-6dc5bc92

```

### Using timezones

By default, `timely` sets the default timezone to `US/Eastern`. However, this can be changed upon instantiation of the `timely` class or via the `set_tz` method. For example:

```python

>>> from timely import Timely

>>> timely = Timely(tz='US/Pacific')

>>> timely.tz = 'US/Mountain'

>>> print(timely.tz)

US/Mountain

```

If the timezone specified does not exist, then `UTC` is used.

When assigning the timezone, the `set` method will create a tag `tz` for EC2 containers with the timezone that was specified. Whenever the `check` method is called, the `tz` tag that is assigned to the EC2 container is used to determine whether or not it should be running.