Add readthedocs documentation.

ip2location · ip2location · commit d284564784ba · 2024-01-05T16:24:19.000+08:00
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,6 @@
+# Defining the exact version will make sure things don't break
+sphinx-book-theme==1.0.1
+# sphinx-pdj-theme==0.4.0
+myst-parser==2.0.0
+markdown-it-py==3.0.0
+sphinx-copybutton==0.5.2
diff --git a/docs/source/code.md b/docs/source/code.md
@@ -0,0 +1,35 @@
+# IP2Proxy R API
+
+## IP2Proxy Class
+
+```{py:function} open(binpath)
+Load the IP2Proxy BIN database for lookup.
+
+:param str binpath: (Required) The file path links to IP2Proxy BIN databases.
+```
+
+```{py:function} get_all(ip)
+Retrieve geolocation information for an IP address.
+
+:param string ip: (Required) The IP address (IPv4 or IPv6).
+:return: Returns the geolocation information in array. Refer below table for the fields avaliable in the array
+:rtype: array
+
+**RETURN FIELDS**
+
+| Field Name       | Description                                                  |
+| ---------------- | ------------------------------------------------------------ |
+| country_short    |     Two-character country code based on ISO 3166. |
+| country_long    |     Country name based on ISO 3166. |
+| region     |     Region or state name. |
+| city       |     City name. |
+| isp            |     Internet Service Provider or company\'s name. |
+| domain         |     Internet domain name associated with IP address range. |
+| usage_type      |     Usage type classification of ISP or company. |
+| asn            |     Autonomous system number (ASN). |
+| as_name             |     Autonomous system (AS) name. |
+| last_seen       |     Proxy last seen in days. |
+| threat         |     Security threat reported. |
+| proxy_type      |     Type of proxy. |
+| provider       |     Name of VPN provider if available. |
+```
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,60 @@
+# Configuration file for the Sphinx documentation builder.
+# Read https://www.sphinx-doc.org/en/master/usage/configuration.html for more options available
+
+# -- Project information
+
+project = 'IP2Proxy R'
+copyright = '2024, IP2Location'
+author = 'IP2Location'
+
+release = '0.1.0'
+version = '0.1.0'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'myst_parser',
+    'sphinx_copybutton',
+]
+
+# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
+
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "fieldlist",
+]
+
+# https://myst-parser.readthedocs.io/en/latest/configuration.html#setting-html-metadata
+myst_html_meta = {
+    "description": "IP2Proxy R package enables user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.",
+    "keywords": "IP2Proxy, Proxy, IP location, R",
+    "google-site-verification": "DeW6mXDyMnMt4i61ZJBNuoADPimo5266DKob7Z7d6i4",
+}
+
+# templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_book_theme'
+
+html_theme_options = {
+    "use_edit_page_button": False,
+    "use_source_button": False,
+    "use_issues_button": False,
+    "use_download_button": False,
+    "use_sidenotes": False,
+}
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = 'images/ipl-logo-square-1200.png'
+
+# Favicon
+html_favicon = 'images/favicon.ico'
+
+html_title = "IP2Proxy R"
+
+# html_baseurl = "https://ip2proxy-deno.readthedocs.io/en/latest/"
diff --git a/docs/source/images/favicon.ico b/docs/source/images/favicon.ico
diff --git a/docs/source/images/ipl-logo-square-1200.png b/docs/source/images/ipl-logo-square-1200.png
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,15 @@
+# IP2Proxy R package
+
+This library allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. It lookup the proxy IP address from **IP2Proxy BIN Data** file. This data file can be downloaded at
+
+- Free IP2Proxy BIN Data: [https://lite.ip2location.com](https://lite.ip2location.com/)
+- Commercial IP2Proxy BIN Data: https://www.ip2location.com/proxy-database
+
+## Table of contents
+ ```{eval-rst}
+ .. toctree::
+
+   self
+   quickstart
+   code
+ ```
diff --git a/docs/source/quickstart.md b/docs/source/quickstart.md
@@ -0,0 +1,41 @@
+# Quickstart
+
+## Dependencies
+
+IP2Proxy R package requires IP2Proxy BIN database to function. You may download the BIN database at
+
+-   IP2Proxy LITE BIN Data (Free): <https://lite.ip2location.com>
+-   IP2Proxy Commercial BIN Data (Comprehensive):
+    <https://www.ip2location.com>
+
+IP2Proxy R package required IP2Proxy Python library to work. In order to install IP2Proxy Python library, you can use the following command:
+
+   ```Python
+   pip install IP2Proxy
+   ```
+
+## Installation
+
+1. In your RStudio IDE, type the following command into the console:
+
+   ```R
+   install.packages("devtools")
+   require(devtools)
+   ```
+
+2. After that, install IP2Proxy R package by using the following command: `install_github("ip2location/ip2proxy-r")`
+
+## Sample Codes
+
+### Query geolocation information from BIN database
+
+You can query the geolocation information from the IP2Proxy BIN database as below:
+
+```r
+library(ip2proxy)
+
+ip2proxy::open("IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP-DOMAIN-USAGETYPE-ASN-LASTSEEN-THREAT-RESIDENTIAL.BIN")
+result = ip2proxy::get_all("8.8.8.8")
+print(result)
+
+```
