Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/daurnimator/mmdblua

Maxmind database parser for lua
https://github.com/daurnimator/mmdblua

geoip lua maxmind-db maxmind-geoip

Last synced: 3 months ago
JSON representation

Maxmind database parser for lua

Awesome Lists containing this project

README

        

# mmdblua

A Lua library for reading [MaxMind's Geolocation database format](https://maxmind.github.io/MaxMind-DB/).

This project had it's initial development sprint done in a hotel room during the [Lua Workshop 2013](https://www.lua.org/wshop13.html).

# Installation

mmdblua is available from [luarocks](https://luarocks.org/).

$ luarocks install mmdblua

## Dependencies

If using lua < 5.3 you will need

- [compat-5.3](https://github.com/keplerproject/lua-compat-5.3) >= 0.3

# Development

## Getting started

- Clone the repo:
```
$ git clone --recursive https://github.com/daurnimator/mmdblua.git
$ cd mmdblua
```
*Note that mmdblua has a git submodule for test data.*

- Lint the code (check for common programming errors)
```
$ luacheck .
```

- Run tests
```
$ busted
```

- Install your local copy:
```
$ luarocks make mmdblua-scm-0.rockspec
```