Giter VIP home page Giter VIP logo

ktoolz's Introduction

ktoolz

GitHub version

No longer maintained!

This library is no longer maintained, please use the successor library katlib https://github.com/LukasForst/katlib

Collection of Kotlin extension functions and utilities.

Using Ktoolz

Ktoolz is hosted on JCenter and therefore one must include to the project.

repositories {
    jcenter()
}

Then to import Ktoolz to Gradle project use:

implementation("ai.blindspot.ktoolz:ktoolz:1.1.0")

Or with Groovy DSL

implementation 'ai.blindspot.ktoolz:ktoolz:1.1.0'

To import Ktoolz to Maven project use:

<dependency>
  <groupId>ai.blindspot.ktoolz</groupId>
  <artifactId>ktoolz</artifactId>
  <version>1.1.0</version>
</dependency>

Deployment

The Ktoolz library is currently hosted on the JCenter repository. To deploy the library to JCenter repository one must set up deployment secrets, the secrets should be stored in the file ktoolz.properties, that is not tracked by the git. The file has following structure:

bintray.user=<user>
bintray.apiKey=<api.key>

To publish the library, one must execute ./gradlew bintrayUpload or using the Makefile - make publish.

To release a new version of the Ktoolz simply call make release VERSION=0.0.0 where 0.0.0 is the new version.

Maintainers

Lukas Forst and Petr Eichler

ktoolz's People

Contributors

lukasforst avatar matyama avatar pavel-jelinek avatar petr-eichler avatar tm-drtina avatar

Stargazers

avatar

Watchers

avatar

Forkers

tm-drtina

ktoolz's Issues

Fix all detekt warnings

Due to misconfiguration, detekt was not working. I fixed the detekt, but now we have a lot of warnings and erros, please fix that.

Fixed detekt is in the branch fix-detekt.

Add CI pipeline

We need CI pipeline which triggers tests on each commit and PR.

Use Github actions to do that - very nice template with CI/CD is for example here

Add documentation and use cases

I think that we are missing examples of the usage of the library. So please add example usage of each function (or at least of the most common) in the readme.

Release pipeline

Please create release pipeline which builds current code base on release published action and deploys it to Bintray and to the Github packages.

Example with full template can be found here

Write some more tests

Although we have code coverage in IntelliJ Idea around 100%, Jacoco reports only around 30%. This is because Jacoco does not count functions that are called from another functions.

Also, it would pretty nice to use Kotlin Test with data generators.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.