Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.89 KB

README.md

File metadata and controls

52 lines (35 loc) · 1.89 KB

CodestatsAPI

Build and tests workflow hex.pm version Hex Docs License Total Download

Elixir library for making requests to Code::Stats. Why not?

The library uses only one external dependency - Jason, to parse the JSON result. For HTTP requests, the built-in OTP :httpc is used.

Requirements

Requirement Version
Erlang/OTP >= 23
Elixir >= 1.10

Installation

Add :codestats_api to your list of dependencies in mix.exs:

def deps do
  [
    {:codestats_api, "~> 0.2.0"}
  ]
end

Usage

Get user's Stats

{:ok, %CodestatsAPI.Stats{}} = CodestatsAPI.get_user_data("username")

That's all :) A detailed description of the Stats structure can be found here.

Contributions

If you feel something can be improved or have any questions about specific behaviors or pieces of implementation, please feel free to file an issue. Proposed changes should be taken to issues before any PRs to save time on code that might not be merged upstream.

If you are ready to change the project, please read the Contributing guide first.

1.0.0 Roadmap

  • Interface to get user's stats
  • Interface to push updates