README

IPToCC
======

Get ISO country code of IPv4/IPv6 address. Address lookup is done
locally.

-  No external API call.
-  No paid GeoIP service.

Read `The Free and Simple Way To Know Who Visits Your
Site <roniemartinez.space/blog/the_free_and_simple_way_to_know_who_visits_your_site>`__.

Features
--------

-  Thread-safe

Install
-------

.. code:: bash

    pip install IPToCC

Usage
-----

.. code:: python

    import iptocc
    country_code = iptocc.get_country_code('<IPv4/IPv6 address>')

Sources
-------

-  ftp://ftp.afrinic.net/stats/afrinic/delegated-afrinic-extended-latest
-  ftp://ftp.arin.net/pub/stats/arin/delegated-arin-extended-latest
-  ftp://ftp.apnic.net/public/apnic/stats/apnic/delegated-apnic-extended-latest
-  ftp://ftp.lacnic.net/pub/stats/lacnic/delegated-lacnic-extended-latest
-  ftp://ftp.ripe.net/pub/stats/ripencc/delegated-ripencc-extended-latest

Libraries Used
--------------

-  `TinyDB <https://github.com/msiemens/tinydb>`__
-  `UltraJSON <https://github.com/esnme/ultrajson>`__

Old implementations
-------------------

-  `SQLAlchemy <https://www.sqlalchemy.org/>`__ + SQLite - Not
   thread-safe
-  `UnQLite <https://github.com/coleifer/unqlite-python>`__ - large
   database file, problems with thread-safety

References
----------

-  `RIR Statistics Exhange
   Format <https://www.apnic.net/about-apnic/corporate-documents/documents/resource-guidelines/rir-statistics-exchange-format/>`__
-  `How can I compile an IP address to country lookup database to make
   available for
   free? <https://webmasters.stackexchange.com/questions/34628/how-can-i-compile-an-ip-address-to-country-lookup-database-to-make-available-for>`__

Author
------

-  `Ronie Martinez <mailto:ronmarti18@gmail.com>`__