https://github.com/mithereal/ex_speedtest

speedtest.net client for elixir
https://github.com/mithereal/ex_speedtest

bandwidth bandwidth-monitor bandwidth-test bandwith bandwith-utilization elixir speed speed-test speedtest

Last synced: about 1 year ago
JSON representation

speedtest.net client for elixir

• Host: GitHub
• URL: https://github.com/mithereal/ex_speedtest
• Owner: mithereal
• License: apache-2.0
• Created: 2019-08-08T00:37:30.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-01T09:29:06.000Z (over 2 years ago)
• Last Synced: 2025-03-24T07:39:49.951Z (about 1 year ago)
• Topics: bandwidth, bandwidth-monitor, bandwidth-test, bandwith, bandwith-utilization, elixir, speed, speed-test, speedtest
• Language: Elixir
• Homepage:
• Size: 44.9 KB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Speedtest

[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/speedtest/)

[![Hex.pm](https://img.shields.io/hexpm/dt/speedtest.svg)](https://hex.pm/packages/speedtest)

[![License](https://img.shields.io/hexpm/l/speedtest.svg)](https://github.com/mithereal/ex_gasoline_price/blob/master/LICENSE)

[![Last Updated](https://img.shields.io/github/last-commit/mithereal/ex_speedtest.svg)](https://github.com/mithereal/ex_speedtest/commits/master)

**Elixir module for testing internet bandwidth using speedtest.net**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `speedtest` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:speedtest, "~> 1.1.1"}

  ]

end

```

## Usage

```elixir

iex> Speedtest.run()

```

## Configuration (optional)

```elixir

config :speedtest,

 key: "xxx",

threads: nil,

 include: nil,

exclude: nil

```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at [https://hexdocs.pm/speedtest](https://hexdocs.pm/speedtest).