https://github.com/DevL/good_times

Expressive and easy to use datetime functions in Elixir.
https://github.com/DevL/good_times

Last synced: about 1 month ago
JSON representation

Expressive and easy to use datetime functions in Elixir.

• Host: GitHub
• URL: https://github.com/DevL/good_times
• Owner: DevL
• License: mit
• Created: 2015-04-11T13:49:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-04-01T10:09:52.000Z (over 1 year ago)
• Last Synced: 2024-10-04T14:47:12.396Z (2 months ago)
• Language: Elixir
• Homepage:
• Size: 126 KB
• Stars: 46
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Expressive and easy to use datetime functions. (Date and Time)
• fucking-awesome-elixir - good_times - Expressive and easy to use datetime functions. (Date and Time)
• awesome-elixir - good_times - Expressive and easy to use datetime functions. (Date and Time)

README

        
# GoodTimes

[![Build Status](https://travis-ci.org/DevL/good_times.svg?branch=master)](https://travis-ci.org/DevL/good_times)

[![Inline docs](http://inch-ci.org/github/DevL/good_times.svg?branch=master)](http://inch-ci.org/github/DevL/good_times)

[![Hex.pm](https://img.shields.io/hexpm/v/good_times.svg)](https://hex.pm/packages/good_times)

[![Documentation](https://img.shields.io/badge/Documentation-online-c800c8.svg)](http://hexdocs.pm/good_times)

Expressive and easy to use datetime functions.

> Unbelivably nice...I'm proud that we have this.

>

> -- _Josh Adams, [Elixir sips](http://elixirsips.com) episode 145_

## Examples

```elixir

iex> import GoodTimes

nil

iex> now

{{2015, 3, 16}, {16, 58, 25}}

iex> 10 |> seconds_from_now

{{2015, 3, 16}, {16, 58, 35}}

iex> 60 |> seconds_ago

{{2015, 3, 16}, {16, 57, 25}}

iex> import GoodTimes.Convert

nil

iex> now |> to_date

{2015, 3, 16}

iex> import GoodTimes.Date

nil

iex> yesterday

{2015, 3, 15}

iex> tomorrow |> at({12, 30, 0})

{{2015, 3, 17}, {12, 30, 0}}

iex> import GoodTimes.Boundary

nil

iex> now |> end_of_week

{{2015, 3, 22}, {23, 59, 59}}

iex> import GoodTimes.Generate

nil

iex> all_days_after({{2016, 2, 28}, {10, 0, 0}}) |> Enum.take(3)

[{{2016, 2, 28}, {10, 0, 0}}, {{2016, 2, 29}, {10, 0, 0}},

 {{2016, 3, 1}, {10, 0, 0}}]

```

## Usage

Update your `mix.exs` file and run `mix deps.get`.

```elixir

defp deps do

  [{:good_times, "~> 1.1"}]

end

```

Import the module or modules holding the functions you want to use.

```elixir

defmodule MyModule do

  import GoodTimes            # core functions.

  import GoodTimes.Boundary   # find boundaries between time units.

  import GoodTimes.Convert    # convert between dates, datetimes and times.

  import GoodTimes.Date       # functions operating on and returning dates.

  import GoodTimes.Generate   # functions generating streams of time units.

```

For more information, see [the full documentation](http://hexdocs.pm/good_times/).

## Known limitations

As GoodTimes uses [Erlangs calendar module](http://erlang.org/doc/man/calendar.html), dates and times before year 0 aren't supported.

## Online documentation

For more information, see [the full documentation](http://hexdocs.pm/good_times).

## Contributing

1. Fork this repository

2. Create your feature branch (`git checkout -b better-times`)

3. Commit your changes (`git commit -am 'Let the good times roll!'`)

4. Push to the branch (`git push origin better-times`)

5. Create a new Pull Request