ipregistry-django 1.0.0__tar.gz

ipregistry_django-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ipregistry_django-1.0.0/PKG-INFO

@@ -0,0 +1,356 @@
+Metadata-Version: 2.4
+Name: ipregistry-django
+Version: 1.0.0
+Summary: Official Django integration for the Ipregistry IP geolocation and threat data API.
+Keywords: django,geoip,geolocation,ip,ip-address,ip-data,ip-geolocation,ipregistry,middleware,proxy-detection,threat-data,vpn-detection
+Author: Ipregistry
+Author-email: Ipregistry <support@ipregistry.co>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: django>=5.2
+Requires-Dist: ipregistry>=5.0.0,<6.0.0
+Requires-Python: >=3.10
+Project-URL: Changelog, https://github.com/ipregistry/ipregistry-django/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://ipregistry.co/docs
+Project-URL: Homepage, https://ipregistry.co
+Project-URL: Issues, https://github.com/ipregistry/ipregistry-django/issues
+Project-URL: Source, https://github.com/ipregistry/ipregistry-django
+Description-Content-Type: text/markdown
+
+# Ipregistry Django
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![CI](https://github.com/ipregistry/ipregistry-django/actions/workflows/ci.yml/badge.svg)](https://github.com/ipregistry/ipregistry-django/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/ipregistry-django.svg)](https://pypi.org/project/ipregistry-django/)
+
+The official Django integration for the [Ipregistry](https://ipregistry.co) IP geolocation
+and threat data API, built on top of [`ipregistry`](https://github.com/ipregistry/ipregistry-python).
+
+```python
+def view(request):
+    if request.ipregistry and request.ipregistry.location.country.code == "FR":
+        ...
+```
+
+## Features
+
+- **`request.ipregistry`** — geolocation and threat data anywhere a request is in scope,
+  queried at most once per request and only when actually accessed.
+- **Middleware and view decorators** to block countries (451) or threats such as proxies,
+  Tor and VPNs (403), site-wide or per-view.
+- **Django caching** — repeated visits from the same IP cost a single credit, backed by
+  any configured cache (Redis, Valkey, Memcached, ...).
+- **GDPR helper** — `is_eu(request)` to decide when to show consent banners.
+- **Safe by default** — fails open on API errors, never sends private IPs, never logs
+  full IP addresses, supports async views and ASGI.
+- **Testable** — `fake_ipregistry()` stubs lookups with zero HTTP and records assertions.
+- **`manage.py ipregistry_lookup`** command and Django system checks for misconfiguration.
+
+## Requirements
+
+- Django 5.2+ (5.2 LTS and 6.0 are tested)
+- Python 3.10+
+
+## Installation
+
+```console
+pip install ipregistry-django
+```
+
+Set your API key ([get one here](https://dashboard.ipregistry.co)), preferably via the
+environment:
+
+```console
+export IPREGISTRY_API_KEY=YOUR_API_KEY
+```
+
+Then enable the app and middleware in `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "ipregistry_django",
+]
+
+MIDDLEWARE = [
+    # ...
+    "ipregistry_django.middleware.IpregistryMiddleware",
+]
+```
+
+That's it. Every view (and everything downstream of the middleware) can now read
+`request.ipregistry`.
+
+## Usage
+
+### Request data
+
+`request.ipregistry` is a lazy [`IpInfo`](https://ipregistry.co/docs/responses) object.
+The API is only queried when the attribute is first accessed, at most once per request:
+
+```python
+def checkout(request):
+    info = request.ipregistry
+    if info:
+        currency = info.currency.code
+        country = info.location.country.name
+        is_vpn = info.security.is_vpn
+```
+
+On lookup failure (or when the client IP is private and no `DEVELOPMENT_IP` is set),
+`request.ipregistry` evaluates to `None`-like falsy and the exception is available at
+`request.ipregistry_error`. Prefer truthiness checks (`if request.ipregistry:`) over
+`is None` because of the lazy wrapper — or call `get_ipregistry(request)` directly:
+
+```python
+from ipregistry_django import get_ipregistry
+
+info = get_ipregistry(request)  # plain IpInfo or None, memoized, never raises
+```
+
+### Async views
+
+```python
+from ipregistry_django import aget_ipregistry
+
+async def view(request):
+    info = await aget_ipregistry(request)
+```
+
+### Direct lookups
+
+For lookups outside the request cycle (Celery tasks, shell, ...), use the module-level
+functions — they share the configured client and cache, and raise on failure:
+
+```python
+import ipregistry_django
+
+response = ipregistry_django.lookup_ip("54.85.132.205")
+print(response.data.location.country.name)
+
+response = ipregistry_django.batch_lookup_ips(["8.8.8.8", "1.1.1.1"])
+response = ipregistry_django.lookup_asn(42)
+response = ipregistry_django.parse_user_agent("Mozilla/5.0 ...")
+response = ipregistry_django.origin_lookup_ip()
+```
+
+### Blocking countries
+
+Site-wide, with middleware:
+
+```python
+MIDDLEWARE = [
+    # ...
+    "ipregistry_django.middleware.BlockCountriesMiddleware",
+]
+
+IPREGISTRY = {
+    "BLOCK_COUNTRIES": ["KP", "SY"],  # or ALLOW_COUNTRIES for an allow-list
+}
+```
+
+Per-view, with decorators:
+
+```python
+from ipregistry_django.decorators import allow_countries, block_countries
+
+@block_countries("KP", "SY")
+def view(request): ...
+
+@allow_countries("DE", "FR")
+def eu_only_view(request): ...
+```
+
+Blocked visitors receive a `451 Unavailable For Legal Reasons` response. Visitors whose
+country cannot be determined pass through (fail-open).
+
+### Blocking threats
+
+```python
+MIDDLEWARE = [
+    # ...
+    "ipregistry_django.middleware.BlockThreatsMiddleware",
+]
+
+IPREGISTRY = {
+    "BLOCK_THREATS": ["proxy", "tor", "vpn"],  # optional extra signals
+}
+```
+
+```python
+from ipregistry_django.decorators import block_threats
+
+@block_threats("proxy", "tor")
+def view(request): ...
+```
+
+IPs flagged as threats, attackers or abusers are always blocked with a `403`. Anonymizing
+services (`anonymous`, `proxy`, `relay`, `tor`, `vpn`) are opt-in signals.
+
+For class-based views, use Django's `method_decorator`:
+
+```python
+from django.utils.decorators import method_decorator
+
+@method_decorator(block_threats("vpn"), name="dispatch")
+class CheckoutView(View): ...
+```
+
+### GDPR / EU detection
+
+```python
+from ipregistry_django import is_bot, is_eu, is_threat
+
+if is_eu(request, assume_eu=True):  # assume EU when unknown: show the banner
+    ...
+
+if is_threat(request, proxy=True, tor=True):
+    ...
+
+if is_bot(request):  # User-Agent heuristic, no API call, no credits
+    ...
+```
+
+### Templates
+
+Add the context processor to render lookup data directly in templates:
+
+```python
+TEMPLATES = [{
+    "OPTIONS": {
+        "context_processors": [
+            # ...
+            "ipregistry_django.context_processors.ipregistry",
+        ],
+    },
+}]
+```
+
+```html
+{% if ipregistry %}Hello, visitor from {{ ipregistry.location.country.name }}!{% endif %}
+```
+
+## Configuration
+
+All settings live in a single optional `IPREGISTRY` dict. Defaults shown:
+
+```python
+IPREGISTRY = {
+    "ALLOW_COUNTRIES": [],        # allow-list for BlockCountriesMiddleware
+    "API_KEY": "",                # falls back to the IPREGISTRY_API_KEY env var
+    "BASE_URL": None,             # None: default endpoint, "eu": EU endpoint, else verbatim
+    "BLOCK_COUNTRIES": [],        # deny-list for BlockCountriesMiddleware
+    "BLOCK_THREATS": [],          # extra signals for BlockThreatsMiddleware
+    "CACHE": True,                # cache lookups with Django's cache framework
+    "CACHE_ALIAS": "default",     # which CACHES alias to use
+    "CACHE_KEY_PREFIX": "ipregistry",
+    "CACHE_TTL": 600,             # seconds
+    "CLIENT_IP_HEADER": None,     # e.g. "X-Forwarded-For" or "CF-Connecting-IP"
+    "DEVELOPMENT_IP": None,       # public IP to use when the client IP is private
+    "EXEMPT_PATHS": None,         # blocker-exempt path prefixes; None: STATIC_URL/MEDIA_URL
+    "FAIL_OPEN": True,            # False: blockers answer 503 on lookup failure
+    "FIELDS": None,               # e.g. "ip,location,security" to lower payload size
+    "HOSTNAME": False,            # resolve reverse DNS hostnames (extra credits)
+    "RETRIES": 1,
+    "RETRY_INTERVAL": 1.0,
+    "RETRY_ON_SERVER_ERROR": True,
+    "RETRY_ON_TOO_MANY_REQUESTS": False,
+    "TIMEOUT": 5,                 # seconds
+}
+```
+
+`API_KEY` and `BASE_URL` also read the `IPREGISTRY_API_KEY` and `IPREGISTRY_BASE_URL`
+environment variables when not set explicitly.
+
+### Client IP and reverse proxies
+
+By default the client IP comes from `REMOTE_ADDR`. Behind a reverse proxy or CDN, set
+`CLIENT_IP_HEADER` to the header your proxy controls — never one clients can spoof:
+
+```python
+IPREGISTRY = {"CLIENT_IP_HEADER": "CF-Connecting-IP"}  # Cloudflare
+IPREGISTRY = {"CLIENT_IP_HEADER": "X-Forwarded-For"}   # nginx with a correct set_real_ip
+```
+
+The first *public* address found wins. Private and reserved addresses are never sent to
+the API; during local development, set `DEVELOPMENT_IP` to a fixed public IP so lookups
+work from localhost.
+
+### Caching
+
+Lookups are cached in the `CACHE_ALIAS` Django cache for `CACHE_TTL` seconds (keys are
+hashed, so any backend works, including Memcached). On top of that, results are memoized
+per request, so accessing `request.ipregistry` repeatedly costs nothing.
+
+### EU endpoint
+
+To ensure requests are handled by Ipregistry nodes hosted in the EU only:
+
+```python
+IPREGISTRY = {"BASE_URL": "eu"}
+```
+
+### Errors
+
+`request.ipregistry`, `get_ipregistry()`, guards, middleware and decorators never raise —
+they fail open and log to the `"ipregistry"` logger (with anonymized IPs). Set
+`"FAIL_OPEN": False` to have the blocking middleware and decorators answer `503` when a
+lookup fails. The direct lookup functions raise `ipregistry.ApiError` /
+`ipregistry.ClientError`.
+
+Run `python manage.py check` to surface configuration problems (missing API key, unknown
+setting keys, invalid country codes or threat signals, unknown cache alias).
+
+## Testing your app
+
+`fake_ipregistry` swaps the shared client for a stub — no HTTP, private test-client IPs
+allowed:
+
+```python
+from ipregistry_django.testing import fake_ipregistry
+
+def test_french_visitor(client):
+    stubs = {"*": {"location": {"country": {"code": "FR", "name": "France"}}}}
+    with fake_ipregistry(stubs) as fake:
+        response = client.get("/")
+        assert "Bienvenue" in response.text
+        fake.assert_looked_up("127.0.0.1")
+```
+
+Stub specific IPs, `"*"` for any IP, `"origin"` for origin lookups; values can be dicts,
+`IpInfo` instances or exceptions. Assertions include `assert_looked_up`,
+`assert_looked_up_times`, `assert_not_looked_up`, `assert_nothing_looked_up`,
+`assert_origin_looked_up` and `assert_user_agents_parsed`.
+
+## Management command
+
+```console
+python manage.py ipregistry_lookup                  # this machine's public IP
+python manage.py ipregistry_lookup 8.8.8.8 1.1.1.1  # one or more IPs
+python manage.py ipregistry_lookup 8.8.8.8 --fields ip,location --hostname
+```
+
+## Resources
+
+- [Ipregistry documentation](https://ipregistry.co/docs)
+- [Response fields](https://ipregistry.co/docs/responses)
+- [Python SDK](https://github.com/ipregistry/ipregistry-python)
+
+## License
+
+[Apache License 2.0](LICENSE)