Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/code-hex/synchro

🕰️ Synchro: Timezone-typesafe date and time framework for Go. 🌟 Star to support our work!
https://github.com/code-hex/synchro

calendar date datetime go golang iso8601 time timezone

Last synced: 14 days ago
JSON representation

🕰️ Synchro: Timezone-typesafe date and time framework for Go. 🌟 Star to support our work!

Host: GitHub
URL: https://github.com/code-hex/synchro
Owner: Code-Hex
License: mit
Created: 2023-09-03T08:14:38.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-06-10T06:23:37.000Z (5 months ago)
Last Synced: 2024-10-22T22:55:03.512Z (21 days ago)
Topics: calendar, date, datetime, go, golang, iso8601, time, timezone
Language: Go
Homepage:
Size: 387 KB
Stars: 260
Watchers: 2
Forks: 8
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🕰️ Synchro: Timezone-typesafe date and time framework for Go

[![test](https://github.com/Code-Hex/synchro/actions/workflows/test.yml/badge.svg)](https://github.com/Code-Hex/synchro/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/Code-Hex/synchro/graph/badge.svg?token=VWPbmNRHw8)](https://codecov.io/gh/Code-Hex/synchro) [![Go Reference](https://pkg.go.dev/badge/github.com/Code-Hex/synchro/.svg)](https://pkg.go.dev/github.com/Code-Hex/synchro/)

This is inspired by Rust [chrono](https://github.com/chronotope/chrono)

## Features

- Timezone-typesafe date and time handling

- Easy conversion between time zones

- Support for common date and time operations

- Compatible with the standard `time` package

- Full compatible with [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) ([GoDoc](https://pkg.go.dev/github.com/Code-Hex/synchro/iso8601))

  - ✅ Dates

    - Years

    - Calendar dates

    - Week dates

    - Quarter dates

    - Ordinal dates

  - ✅ Times

  - ✅ Combined date and time representations

  - ✅ Durations

  - ✅ Time intervals

    - Repeating intervals

  - Note: This package can be used as civil time.

    - Civil time is a time-zone-independent representation of time that follows the rules of the proleptic Gregorian calendar with exactly 24-hour days, 60-minute hours, and 60-second minutes.

## Installation

To install Synchro, use `go get`:

    go get github.com/Code-Hex/synchro

## Synopsis

To use Synchro, import it in your Go code:

```go

package main

import (

    "fmt"

    "github.com/Code-Hex/synchro"

    "github.com/Code-Hex/synchro/tz"

)

func main() {

    // The current UTC time is fixed to `2023-09-02 14:00:00`.

    utcNow := synchro.Now[tz.UTC]()

    fmt.Println(utcNow)

    jstNow := synchro.Now[tz.AsiaTokyo]()

    fmt.Println(jstNow)

    // Output:

    // 2009-11-10 23:00:00 +0000 UTC

    // 2009-11-11 08:00:00 +0900 JST

}

```

https://go.dev/play/p/Ql3CM7NLfj0

Please refer to the numerous usage examples on [GoDoc](https://pkg.go.dev/github.com/Code-Hex/synchro/) for reference.

## Utilities

We also have a wide range of very useful utilities!!

If you have a feature request, please open an issue. It would be great if you could provide relevant examples or links that could be helpful.

- [In](https://pkg.go.dev/github.com/Code-Hex/synchro#In)

- [ConvertTz](https://pkg.go.dev/github.com/Code-Hex/synchro#ConvertTz)

- [NowContext](https://pkg.go.dev/github.com/Code-Hex/synchro#NowContext)

- [Quarter](https://pkg.go.dev/github.com/Code-Hex/synchro#Quarter)

- [Semester](https://pkg.go.dev/github.com/Code-Hex/synchro#Semester)

- [StartOfMonth](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.StartOfMonth)

- [EndOfMonth](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.EndOfMonth)

- [StartOfQuarter](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.StartOfQuarter)

- [EndOfQuarter](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.EndOfQuarter)

- [StartOfSemester](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.StartOfSemester)

- [EndOfSemester](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.EndOfSemester)

- [StartOfWeek](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.StartOfWeek)

- [EndOfWeek](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.EndOfWeek)

- [StartOfYear](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.StartOfYear)

- [EndOfYear](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.EndOfYear)

- [IsBetween](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.IsBetween)

- [IsLeapYear](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.IsLeapYear)

- [DiffInCalendarDays](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.DiffInCalendarDays)

- [Change](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.Change)

  - `Change` allows you to specify the date and time components you want to change and make modifications.

- [Advance](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.Advance)

  - `Advance` allows you to specify the date and time components you want to increment and make modifications.

- [Period](https://pkg.go.dev/github.com/Code-Hex/synchro#Period)

- [Strptime](https://pkg.go.dev/github.com/Code-Hex/synchro#Strptime)

- [Strftime](https://pkg.go.dev/github.com/Code-Hex/synchro#Time.Strftime)

## TODO

- [x] Support database/sql

- [ ] Support i18n

- [ ] Optimization

## Contributing

Contributions to Synchro are welcome!

To contribute, please fork the repository and submit a pull request.

## License

Synchro is licensed under the MIT License. See LICENSE for more information.