Skip to content

Commit

Permalink
Ready for 0.0.4 release!! (#220)
Browse files Browse the repository at this point in the history
  • Loading branch information
alfonsorr committed May 26, 2022
1 parent 9ded066 commit 1fb1bf9
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 32 deletions.
39 changes: 24 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ Type-safe columns for spark DataFrames!
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/hablapps/doric/main?filepath=notebooks)

| Spark | Maven Central | Codecov |
|:-----:|:-------------:|:--------|
| 3.0.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.3) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-3.0.x)](https://codecov.io/gh/hablapps/doric) |
| 3.1.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/0.0.3) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-3.1.x)](https://codecov.io/gh/hablapps/doric) |
| 3.2.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/0.0.3) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-3.2.x)](https://codecov.io/gh/hablapps/doric) |
| Spark | Maven Central | Codecov |
|:-----:|:------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------|
| 2.4.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_2-4_2.11)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.4) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-2.4.x)](https://codecov.io/gh/hablapps/doric) |
| 3.0.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.4) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-3.0.x)](https://codecov.io/gh/hablapps/doric) |
| 3.1.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/0.0.4) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-3.1.x)](https://codecov.io/gh/hablapps/doric) |
| 3.2.x | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/0.0.4) | [![codecov](https://codecov.io/gh/hablapps/doric/branch/main/graph/badge.svg?token=N7ZXUXZX1I?flag=spark-3.2.x)](https://codecov.io/gh/hablapps/doric) |
----

Doric offers type-safety in DataFrame column expressions at a minimum
Expand Down Expand Up @@ -46,14 +47,14 @@ Fetch the JAR from Maven:

_Sbt_
```scala
libraryDependencies += "org.hablapps" % "doric_3-2_2.12" % "0.0.3"
libraryDependencies += "org.hablapps" %% "doric_3-2" % "0.0.4"
```
_Maven_
```xml
<dependency>
<groupId>org.hablapps</groupId>
<artifactId>doric_3-2_2.12</artifactId>
<version>0.0.3</version>
<version>0.0.4</version>
</dependency>
```

Expand All @@ -62,14 +63,22 @@ following spark versions.

| Spark | Scala | Tested | doric |
|:-----:|:-----:|:------:|:-----:|
| 3.0.0 | 2.12 || - |
| 3.0.1 | 2.12 || - |
| 3.0.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.3) |
| 3.1.0 | 2.12 || - |
| 3.1.1 | 2.12 || - |
| 3.1.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/0.0.3) |
| 3.2.0 | 2.12 || - |
| 3.2.1 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/0.0.3) |
| 2.4.1 | 2.11 || - |
| 2.4.2 | 2.11 || - |
| 2.4.3 | 2.11 || - |
| 2.4.4 | 2.11 || - |
| 2.4.5 | 2.11 || - |
| 2.4.6 | 2.11 || - |
| 2.4.7 | 2.11 || - |
| 2.4.8 | 2.11 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_2-4_2.11)](https://mvnrepository.com/artifact/org.hablapps/doric_2-4_2.11/0.0.4) |
| 3.0.0 | 2.12 || - |
| 3.0.1 | 2.12 || - |
| 3.0.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.4) |
| 3.1.0 | 2.12 || - |
| 3.1.1 | 2.12 || - |
| 3.1.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/0.0.4) |
| 3.2.0 | 2.12 || - |
| 3.2.1 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/0.0.4) |


## Contributing
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import sbt.{Compile, Def}

val stableVersion = "0.0.3"
val stableVersion = "0.0.4"

val sparkDefaultShortVersion = "3.2"
val spark24Version = "2.4.8"
Expand Down
11 changes: 6 additions & 5 deletions docs/docs/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ permalink: docs/api/

Here you can see the whole doric API for every supported spark version:

| Spark | Scala | doric |
|:------------:|:-----:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [3.0.2](3.0) | 2.12 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/@STABLE_VERSION@) |
| [3.1.2](3.1) | 2.12 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/@STABLE_VERSION@) |
| [3.2.1](3.2) | 2.12 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/@STABLE_VERSION@) |
| Spark | Scala | doric |
|:----------------------------:|:-----:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [2.4.8](2.4/scala-2.11/api/) | 2.11 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_2-4_2.11)](https://mvnrepository.com/artifact/org.hablapps/doric_2-4_2.11/@STABLE_VERSION@) |
| [3.0.2](3.0/scala-2.12/api/) | 2.12 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/@STABLE_VERSION@) |
| [3.1.2](3.1/scala-2.12/api/) | 2.12 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/@STABLE_VERSION@) |
| [3.2.1](3.2/scala-2.12/api/) | 2.12 | [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/@STABLE_VERSION@) |
30 changes: 19 additions & 11 deletions docs/docs/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,24 @@ Doric is committed to use the most modern APIs first.
* The latest experimental version of doric is @VERSION@.
* Doric is compatible with the following Spark versions:

| Spark | Scala | Tested | doric |
|:-----:|:-----:|:------:|:-----:|
| 3.0.0 | 2.12 || - |
| 3.0.1 | 2.12 || - |
| 3.0.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.3) |
| 3.1.0 | 2.12 || - |
| 3.1.1 | 2.12 || - |
| 3.1.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/0.0.3) |
| 3.2.0 | 2.12 || - |
| 3.2.1 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/0.0.3) |
| Spark | Scala | Tested | doric |
|:-----:|:-----:|:------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 2.4.1 | 2.11 || - |
| 2.4.2 | 2.11 || - |
| 2.4.3 | 2.11 || - |
| 2.4.4 | 2.11 || - |
| 2.4.5 | 2.11 || - |
| 2.4.6 | 2.11 || - |
| 2.4.7 | 2.11 || - |
| 2.4.8 | 2.11 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_2-4_2.11)](https://mvnrepository.com/artifact/org.hablapps/doric_2-4_2.11/0.0.4) |
| 3.0.0 | 2.12 || - |
| 3.0.1 | 2.12 || - |
| 3.0.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-0_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-0_2.12/0.0.4) |
| 3.1.0 | 2.12 || - |
| 3.1.1 | 2.12 || - |
| 3.1.2 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-1_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-1_2.12/0.0.4) |
| 3.2.0 | 2.12 || - |
| 3.2.1 | 2.12 || [![Maven Central](https://img.shields.io/maven-central/v/org.hablapps/doric_3-2_2.12)](https://mvnrepository.com/artifact/org.hablapps/doric_3-2_2.12/0.0.4) |


__Import statements__
Expand Down Expand Up @@ -107,7 +115,7 @@ are interpreted within the context of `withColumn`, `select`, etc.

Since doric is intended as a replacement of the _whole_ DataFrame API, type-safe versions of Spark functions
for numbers, dates, strings, etc., are provided. To know all possible transformations, you can take a look at
the [DoricColumn API](https://www.hablapps.com/doric/docs/api/latest/doric/DoricColumn.html) .Occasionally, however, we might need to mix
the [DoricColumn API](https://www.hablapps.com/doric/docs/api/3.2/scala-2.12/api/doric/DoricColumn.html) .Occasionally, however, we might need to mix
both doric and Spark column expressions. There is no problem with that, as this example shows:

```scala mdoc
Expand Down

0 comments on commit 1fb1bf9

Please sign in to comment.