fiftyone-ipintelligence-onpremise 4.5.0__tar.gz

fiftyone_ipintelligence_onpremise-4.5.0/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include src/fiftyone_ipintelligence_onpremise/cxx/src *.hpp
+recursive-include src/fiftyone_ipintelligence_onpremise/cxx/src *.h
+recursive-include src/fiftyone_ipintelligence_onpremise/cxx/src *.i
+include version.txt

fiftyone_ipintelligence_onpremise-4.5.0/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.1
+Name: fiftyone_ipintelligence_onpremise
+Version: 4.5.0
+Summary: This project contains the 51Degrees IP Intelligence OnPremise engine that can be used with the 51Degrees Pipeline API. The Pipeline is a generic web request intelligence and data processing solution with the ability to add a range of 51Degrees and/or custom plug ins (Engines)
+Author: 51Degrees Engineering
+Author-email: engineering@51degrees.com
+License: EUPL-1.2
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# 51Degrees IP Intelligence Engines - OnPremise
+
+![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=readme&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_onpremise-readme.md&utm_term=51degrees-ip-intelligence-engines-onpremise "Data rewards the curious") **Python IP Intelligence**
+
+[Developer Documentation](https://51degrees.com/ip-intelligence-python/index.html?utm_source=github&utm_medium=readme&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_onpremise-readme.md&utm_term=51degrees-ip-intelligence-engines-onpremise "developer documentation")
+
+## Introduction
+
+This package resolves IP addresses to location, network and registration
+information using a local `.ipi` data file and the
+[51Degrees Pipeline API](https://51degrees.com/documentation/index.html?utm_source=github&utm_medium=readme&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_onpremise-readme.md&utm_term=introduction).
+
+The native [ip-intelligence-cxx](https://github.com/51Degrees/ip-intelligence-cxx)
+library is included as a git submodule and wrapped with SWIG.
+
+## Building
+
+The SWIG generated wrapper (`ipi_python_wrap.cxx` and
+`IpIntelligenceEngineModule.py`) is committed to the repository so SWIG is
+only needed when regenerating it (run `PreBuild.bat` / `PreBuild.sh`).
+
+A C++17 compiler is required to build the native extension:
+
+```
+git submodule update --init --recursive
+python setup.py build_clib build_ext
+```
+
+## Data files
+
+The on-premise engine requires a `.ipi` data file. A Lite data file can be
+downloaded from
+[51Degrees](https://51ddatafiles.blob.core.windows.net/enterpriseipi/51Degrees-LiteIpiV41.ipi.gz),
+see also the [ip-intelligence-data](https://github.com/51Degrees/ip-intelligence-data)
+repository which is included as a nested submodule and contains evidence
+files for testing.
+
+## Usage
+
+```python
+from fiftyone_ipintelligence_onpremise.ipintelligence_onpremise_pipelinebuilder import IpIntelligenceOnPremisePipelineBuilder
+
+pipeline = IpIntelligenceOnPremisePipelineBuilder(
+    data_file_path="51Degrees-LiteIpiV41.ipi",
+    licence_keys="",
+    usage_sharing=False).build()
+
+flowdata = pipeline.create_flowdata()
+flowdata.evidence.add("query.client-ip", "185.28.167.78")
+flowdata.process()
+print(flowdata.ip.registeredname.value())
+```

fiftyone_ipintelligence_onpremise-4.5.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "Cython"]
+build-backend = "setuptools.build_meta"

fiftyone_ipintelligence_onpremise-4.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fiftyone_ipintelligence_onpremise-4.5.0/setup.py

@@ -0,0 +1,265 @@
+# *********************************************************************
+# This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+# Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
+# Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+#
+# This Original Work is licensed under the European Union Public Licence
+# (EUPL) v.1.2 and is subject to its terms as set out below.
+#
+# If a copy of the EUPL was not distributed with this file, You can obtain
+# one at https://opensource.org/licenses/EUPL-1.2.
+#
+# The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+# amended by the European Commission) shall be deemed incompatible for
+# the purposes of the Work and the provisions of the compatibility
+# clause in Article 5 of the EUPL shall not apply.
+#
+# If using the Work as, or as part of, a network application, by
+# including the attribution notice(s) required under Article 5 of the EUPL
+# in the end user terms of the application under an appropriate heading,
+# such notice(s) shall fulfill the requirements of that article.
+# *********************************************************************
+
+"""
+setup.py file for SWIG
+"""
+import sys
+import platform
+from setuptools import setup, Extension
+from setuptools.command import develop
+from distutils import sysconfig
+from Cython.Distutils import build_ext
+from glob import glob
+import os
+import io
+import shutil
+
+# Read a text file and return the content as a string.
+def read(file_name):
+
+    """Read a text file and return the content as a string."""
+    try:
+        with io.open(
+            os.path.join(os.path.dirname(__file__), file_name), encoding="utf-8"
+        ) as f:
+            return f.read().strip()
+    except:
+        return "0.0.0"
+
+def get_version():
+
+    version = None
+
+    # Try to get the correct version from platform.
+    is_64bits = sys.maxsize > 2**32
+    if is_64bits:
+        if 'Windows' in platform.system():
+            version = "win_64_"
+        if 'Linux' in platform.system():
+            version = "linux_64_"
+        if 'Darwin' in platform.system():
+            version = "darwin_64_"
+    else:
+        if 'Windows' in platform.system():
+            version = "win_32_"
+        if 'Linux' in platform.system():
+            version = "linux_32_"
+        if 'Darwin' in platform.system():
+            # No 32 bit python on Mac
+            version = None
+            raise Exception("Sorry, No 32 bit Python on Mac")
+
+    python_version = str(sys.version_info[0])
+    return version + python_version
+
+class NoSuffixBuilder(build_ext):
+    def get_ext_filename(self, ext_name):
+        filename = super().get_ext_filename(ext_name)
+        suffix = sysconfig.get_config_var('EXT_SUFFIX')
+        if suffix is None:
+            suffix = sysconfig.get_config_var('SO')
+
+        print("**" + filename + "**\r\n")
+        print("**" + suffix + "**\r\n")
+
+        # Get the version from the suffix.
+        version = get_version()
+
+        ext = os.path.splitext(filename)[1]
+
+        if self.inplace:
+            return "./" + filename.replace(suffix, "") + ext
+        else:
+            return filename.replace(suffix, "") + ext
+
+# IP intelligence data files are large so 64 bit file offsets must be
+# used when reading them. All the native libraries (wrapper, C++ and C)
+# must be compiled with the same setting.
+#
+# FIFTYONE_DEGREES_REDUCED_FILE must also be defined to match the cxx
+# CMake build (option ReducedFile, ON by default). It changes on-disk
+# struct layouts (see common-cxx profile.h / value.h) for the reduced
+# data file format used by 4.5 and later data files. The .NET and Java
+# bindings build the cxx via CMake and so inherit this define; the Python
+# build must set it explicitly or it reads the data file with the wrong
+# struct layout (empty results and crashes). All three native libraries
+# (wrapper, C++ and C) must be compiled with the same setting.
+
+def stage_native_source():
+
+    """Copy the native source this engine is built from into the package.
+
+    The source is kept once, in the cxx submodule at the root of
+    51degrees-python (51degrees-cxx), and a package can only build and ship
+    files inside its own folder, so the parts it needs are copied here and the
+    source distribution carries them. Building from a source distribution has
+    the copy already and no cxx folder above it, so nothing is copied then."""
+
+    here = os.path.dirname(os.path.abspath(__file__))
+    source = os.path.join(here, "..", "..", "cxx", "src")
+    dest = os.path.join(here, "src", "fiftyone_ipintelligence_onpremise", "cxx", "src")
+    if os.path.isdir(source) == False:
+        if os.path.isdir(dest) == False:
+            raise RuntimeError(
+                "No native source: check out the cxx submodule at the root "
+                "of 51degrees-python (git submodule update --init cxx).")
+        return
+    # IP Intelligence needs common and its own folder only. Each package compiles
+    # its own copy of common, because IP Intelligence builds it with settings
+    # that change structure sizes.
+    for folder in ('common', 'ipi'):
+        target = os.path.join(dest, folder)
+        shutil.rmtree(target, ignore_errors=True)
+        shutil.copytree(os.path.join(source, folder), target)
+
+
+stage_native_source()
+
+define_macros = [
+    ('FIFTYONE_DEGREES_LARGE_DATA_FILE_SUPPORT', '1'),
+    ('FIFTYONE_DEGREES_REDUCED_FILE', '1')]
+extra_compile_args = [
+    '-DFIFTYONE_DEGREES_LARGE_DATA_FILE_SUPPORT=1',
+    '-DFIFTYONE_DEGREES_REDUCED_FILE=1']
+extra_link_args = []
+# Extra compilation flags for C library
+cflags = [
+    '-DFIFTYONE_DEGREES_LARGE_DATA_FILE_SUPPORT=1',
+    '-DFIFTYONE_DEGREES_REDUCED_FILE=1']
+
+if sys.platform != "win32":
+    extra_compile_args.extend([
+        '-fPIC',
+        '-std=gnu++17',
+        '-Wall',
+        '-D_FILE_OFFSET_BITS=64',
+        # '-Werror'
+    ])
+    cflags.extend([
+        '-std=gnu11',
+        '-Wall',
+        '-D_FILE_OFFSET_BITS=64',
+        # '-Werror',
+        '-Wno-strict-prototypes',
+        '-Wno-unused-variable',
+        '-Wno-missing-braces',
+        '-Wno-strict-aliasing'
+    ])
+
+
+if sys.platform == "win32":
+    extra_compile_args.extend([
+        '/std:c++17',
+        '/D_CRT_SECURE_NO_WARNINGS',
+        '/D_UNICODE',
+        '/DUNICODE',
+        '/W4',
+        # '/WX',
+        '/wd4127',
+        '/wd4456',
+        '/wd4701',
+        '/wd4703',
+        '/wd4706'
+    ])
+    cflags.extend([
+        '/D_CRT_SECURE_NO_WARNINGS',
+        '/D_UNICODE',
+        '/DUNICODE',
+        '/W4',
+        # '/WX'
+    ])
+    extra_link_args.extend([
+        '/WX'
+    ])
+
+if sys.platform == "linux":
+    extra_link_args.extend([
+        '-latomic'
+    ])
+
+if sys.platform == 'darwin':
+    # This is flaged in CPython
+    extra_compile_args.extend([
+        '-DGCC_ENABLE_CPP_EXCEPTIONS=YES'
+    ])
+    if sys.version_info[0] == 3 and sys.version_info[1] == 8:
+        extra_compile_args.extend([
+            '-Wno-deprecated-declarations'
+    ])
+    cflags.extend([
+        '-Wno-atomic-alignment'
+    ])
+
+IpIntelligenceEngineModule = Extension('_IpIntelligenceEngineModule',
+        sources=[
+        # Python Wrapper
+        # "fiftyone_ipintelligence_onpremise/ipi_python.i"
+        "src/fiftyone_ipintelligence_onpremise/ipi_python_wrap.cxx"
+        ],
+        define_macros=define_macros,
+        extra_compile_args=extra_compile_args,
+        extra_link_args=extra_link_args,
+        language='c++',
+    )
+
+cpplib = ('cpplib', {
+        'sources': [
+            # Common C++
+            *glob("src/fiftyone_ipintelligence_onpremise/cxx/src/common/*.cpp"),
+            # IP Intelligence C++
+            *glob("src/fiftyone_ipintelligence_onpremise/cxx/src/ipi/*.cpp"),
+            ],
+        'cflags': extra_compile_args
+    })
+
+clib = ('clib', {
+        'sources': [
+            # Common C
+            *glob("src/fiftyone_ipintelligence_onpremise/cxx/src/common/*.c"),
+            # IP Intelligence C
+            *glob("src/fiftyone_ipintelligence_onpremise/cxx/src/ipi/*.c"),
+            # IP Graph C
+            *glob("src/fiftyone_ipintelligence_onpremise/cxx/src/ipi/graph/*.c"),
+        ],
+        'cflags': cflags
+    })
+
+setup(
+    cmdclass={"build_ext": NoSuffixBuilder},
+    name="fiftyone_ipintelligence_onpremise",
+    version=read("version.txt"),
+    author="51Degrees Engineering",
+    author_email="engineering@51degrees.com",
+    description = """This project contains the 51Degrees IP Intelligence OnPremise engine that can be used with the 51Degrees Pipeline API. The Pipeline is a generic web request intelligence and data processing solution with the ability to add a range of 51Degrees and/or custom plug ins (Engines)""",
+    long_description=read("readme.md"),
+    long_description_content_type="text/markdown",
+    python_requires=">=3.10",
+    license="EUPL-1.2",
+    libraries=[cpplib, clib],
+    ext_package="fiftyone_ipintelligence_onpremise",
+    ext_modules=[IpIntelligenceEngineModule],
+    py_modules=["fiftyone_ipintelligence_onpremise"],
+    packages=["fiftyone_ipintelligence_onpremise"],
+    package_dir={"": "src"},
+    install_requires=["fiftyone_ipintelligence_shared", "fiftyone_pipeline_engines_fiftyone"],
+)