Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hitblast/nimip
⚡ Asynchronously lookup IP addresses with this tiny, hybrid Nim application.
https://github.com/hitblast/nimip
api-wrapper ip-address-lookup ip-api nim nim-lang
Last synced: 24 days ago
JSON representation
⚡ Asynchronously lookup IP addresses with this tiny, hybrid Nim application.
- Host: GitHub
- URL: https://github.com/hitblast/nimip
- Owner: hitblast
- License: mit
- Created: 2023-06-12T04:50:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-06T09:57:14.000Z (5 months ago)
- Last Synced: 2024-10-18T14:29:41.729Z (2 months ago)
- Topics: api-wrapper, ip-address-lookup, ip-api, nim, nim-lang
- Language: Nim
- Homepage: https://hitblast.github.io/nimip/
- Size: 2.55 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 
nimip
### Asynchronously lookup IP addresses with this tiny, hybrid Nim application.
[](https://github.com/hitblast/nimip/actions/workflows/build.yml)
[](https://github.com/hitblast/nimip/actions/workflows/pages.yml)
## Table of Contents
- [Overview](#-overview)
- [Installation](#-installation)
- [Usage](#-usage)
- [as a CLI application](#-as-a-cli-application)
- [as a Nim library](#-as-a-nim-library)
- [Building](#-building)
- [License](#-license)
## 📖 Overview
This project, AKA nimip, is a hybrid and asynchronous wrapper around [ip-api](https://ip-api.com), a free geolocation API which can be used to lookup a domain or IP address. The user can provide an **IPv4 / IPv6** compliant address and nimip can query for it with speed, whilst being a very tiny package.
As a developer, I'm still learning the Nim programming language (pretty awesome!) and nimip is one of my hobby projects which I had a lot of fun programming on. It has definitely helped me get in-depth with the language itself and hopefully, it'll be helpful to those who need to constantly access information on IP addresses.
## 📦 Installation
- ### Nim (using [nimble](https://github.com/nim-lang/nimble))
```bash
# Requires Nim v2.0 or greater.
$ nimble install nimip
```
- ### macOS (using [Homebrew](https://brew.sh))
```bash
# Tapping the formula.
$ brew tap hitblast/nimtap
# Install using the `brew install` command.
$ brew install nimip
```
- ### Binary Downloads
You can manually download the packaged versions of nimip from the latest release in the [Releases](https://github.com/hitblast/nimip/releases) section. The [build artifacts](https://github.com/hitblast/nimip/actions/workflows/builds.yml) are also stored for you to download as well.
## ⚡ Usage
This project is written as a [hybrid package](https://github.com/nim-lang/nimble#hybrids). Meaning that it can be used as both a Nim library and a standalone CLI application inside your terminal. The choice is yours.
### ... as a CLI application
After installing the package [(see this section)](#-installation), the binary for nimip should be in your `PATH` variable depending on how you've installed it. This means, a new `nimip` command will be added to your shell environment.
```bash
# Add binary to PATH.
$ export PATH="path/to/nimip/binary:$PATH"
```
Afterwards, simply run it using the following command snippets:
```bash
# The default help command.
$ nimip --help # -h also works
# Lookup an IP.
$ nimip 104.21.29.128
```
### ... as a Nim library
This project can also be used as a Nim library. Here's an example snippet for you to have a look at. For more information on the different procedure, try having a look at [the official documentation](https://hitblast.github.io/nimip/).
```nim
# Sample imports.
import std/[
asyncdispatch,
strformat
]
import nimip/main
# Creating a new IP reference object.
let ip = IPRef(
address: "104.21.29.128",
locale: Locale.EN
)
# The main procedure.
proc main() {.async.} =
# Checks if the IP address can be queried.
try:
await ip.refreshData()
except IPResponseError:
echo "Could not query for IP address."
quit(1)
# If everything goes well, display the information.
echo fmt"IP Location: {ip.latitude}, {ip.longitude}"
# Running it.
waitFor main()
```
## 🔨 Building
```bash
# Prepare a release build.
$ nimble build -d:ssl -d:release --accept
```
The various third-party libraries and dependancies used for developing this project are mentioned below:
- Internal dependencies:
1. The [argparse](https://nimble.directory/pkg/argparse) library, for parsing command-line arguments for the CLI binary.
2. The [illwill](https://nimble.directory/pkg/illwill) library, for the terminal user interface (TUI).
- External dependencies (noted in the [root .nimble](https://github.com/hitblast/nimip/blob/main/nimip.nimble) file):
1. [OpenSSL](https://www.openssl.org) for connection and making API calls.
## 🔖 License
This project is licensed under the [MIT License](https://github.com/hitblast/nimip/blob/main/LICENSE).