Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philippus/emoji-clock
🕟 Generate the emoji clock face, moon phase 🌗 , or zodiac sign ♉ 🐶 for a given time
https://github.com/philippus/emoji-clock
clock clockface emoji moon-phase scala zodiac-sign
Last synced: 9 days ago
JSON representation
🕟 Generate the emoji clock face, moon phase 🌗 , or zodiac sign ♉ 🐶 for a given time
- Host: GitHub
- URL: https://github.com/philippus/emoji-clock
- Owner: Philippus
- License: mit
- Created: 2017-09-09T15:53:35.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T19:51:03.000Z (17 days ago)
- Last Synced: 2024-10-21T00:25:01.232Z (17 days ago)
- Topics: clock, clockface, emoji, moon-phase, scala, zodiac-sign
- Language: Scala
- Homepage:
- Size: 397 KB
- Stars: 16
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Emoji-clock
[](https://github.com/Philippus/emoji-clock/actions/workflows/scala.yml?query=workflow%3Abuild+branch%3Amain)
[](https://codecov.io/gh/Philippus/emoji-clock)
[](LICENSE.md)
Emoji-clock can, when given a date-time, generate the applicable emoji short code for:
- clock faces
- lunar phases
- (tropical) zodiac signs
- chinese zodiac signs
To view the emoji itself you will need an emoji library such as [Lightbend Emoji](https://github.com/typesafehub/lightbend-emoji).
## Installation
Emoji-clock is published for Scala 2.12 and 2.13. To start using it add the following to your `build.sbt`:
```
libraryDependencies += "nl.gn0s1s" %% "emoji-clock" % "0.3.1"
```
## Example usage
Follow the Lightbend Emoji [installation instructions](https://github.com/typesafehub/lightbend-emoji#installation) also for these examples:
```scala
import nl.gn0s1s.emojiclock.EmojiClock
import com.lightbend.emoji.ShortCodes.Defaults._
import com.lightbend.emoji.ShortCodes.Implicits._
EmojiClock.clockFaceShortCode(java.time.LocalDateTime.of(2018, 1, 31, 1, 50))
// res0: String = clock2
EmojiClock.clockFaceShortCode(java.time.LocalDateTime.of(2018, 1, 31, 1, 50)).emoji
// res1: com.lightbend.emoji.Emoji = 🕑
EmojiClock.now() // at 16:44
// res2: String = clock430
EmojiClock.now().emoji
// res3: com.lightbend.emoji.Emoji = 🕟
```
```scala
import nl.gn0s1s.emojiclock.EmojiLunarPhase
import com.lightbend.emoji.ShortCodes.Defaults._
import com.lightbend.emoji.ShortCodes.Implicits._
EmojiLunarPhase.lunarPhaseShortCode(java.time.LocalDateTime.of(2018, 1, 31, 0, 0))
// res0: String = full_moon
EmojiLunarPhase.lunarPhaseShortCode(java.time.LocalDateTime.of(2017, 12, 10, 0, 0)).emoji
// res1: com.lightbend.emoji.Emoji = 🌗
EmojiLunarPhase.now() // at 1st December 2017
// res2: String = full_moon
EmojiLunarPhase.now().emoji
// res3: com.lightbend.emoji.Emoji = 🌕
```
```scala
import nl.gn0s1s.emojiclock.EmojiZodiacSign
import com.lightbend.emoji.ShortCodes.Defaults._
import com.lightbend.emoji.ShortCodes.Implicits._
EmojiZodiacSign.zodiacSignShortCode(java.time.LocalDateTime.of(2018, 1, 31, 0, 0))
// res0: String = aquarius
EmojiZodiacSign.zodiacSignShortCode(java.time.LocalDateTime.of(2017, 5, 5, 0, 0)).emoji
// res1: com.lightbend.emoji.Emoji = ♉
EmojiZodiacSign.now() // at 2nd December 2017
// res2: String = sagittarius
EmojiZodiacSign.now().emoji
// res3: com.lightbend.emoji.Emoji = ♐
```
```scala
import nl.gn0s1s.emojiclock.EmojiChineseZodiac
import com.lightbend.emoji.ShortCodes.Defaults._
import com.lightbend.emoji.ShortCodes.Implicits._
EmojiChineseZodiac.chineseZodiacSignShortCode(java.time.LocalDateTime.of(2018, 1, 31, 0, 0))
// res0: String = rooster
EmojiChineseZodiac.chineseZodiacSignShortCode(java.time.LocalDateTime.of(2015, 5, 5, 0, 0)).emoji
// res1: com.lightbend.emoji.Emoji = 🐐
EmojiChineseZodiac.now() // at 1st January 2019
// res2: String = dog
EmojiChineseZodiac.now().emoji
// res3: com.lightbend.emoji.Emoji = 🐶
```
### sbt-prompt
in [examples/sbt-prompt](examples/sbt-prompt) you can see how you could add an emoji clock to your [sbt-prompt](https://github.com/agemooij/sbt-prompt).
## Links
- Emo R package that does something similar for R - https://github.com/hadley/emo
- Rust crate that does something similar for the cli - https://github.com/softprops/emoji-clock
- Lunar phase - https://en.wikipedia.org/wiki/Lunar_phase
- Sidereal and tropical astrology - https://en.wikipedia.org/wiki/Sidereal_and_tropical_astrology
- Chinese zodiac - https://en.wikipedia.org/wiki/Chinese_zodiac
## License
The code is available under the [MIT license](LICENSE.md).