Metadata-Version: 2.4
Name: folium_offline
Version: 0.20.0.2
Summary: Offline version of folium with web resources embedded. All credit lies with Rob Story, creator of folium.
Home-page: https://github.com/python-visualization/folium
Author: Sandia National Laboratories
Author-email: bdnewto@sandia.gov
License: MIT
Keywords: data visualization
Platform: any
Classifier: Programming Language :: Python :: 3.9
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: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: branca>=0.6.0
Requires-Dist: jinja2>=2.9
Requires-Dist: numpy
Requires-Dist: requests
Requires-Dist: xyzservices
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary


offlinefolium
=============

Offline Leaflet.js Maps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`offlinefolium` allows folium maps to be rendered without access to Internet resources.  Javascript, CSS, and image resources are embedded rather than downloaded from the web.  Map tiles can be displayed from a map tile server on a local network, and folium maps can be rendered with no need to connect the network to the Internet.  Most plugins also function fully offline.  

offlinefolium is essentially a copy of folium with a few tweaks to allow resources to be embedded rather the downloaded on the fly.  The cost of this embedding is the use of at least an additional 1.4 Megabytes of memory for each map rendered, and/or 1.4 Megabytes of additional disk space for each map stored as an html file, using m.save("filename.html").  All credit for folium belongs to Rob Story, the creator of folium.  offlinefolium is just a minor extension of folium's capabilities for a very specific use case.

Installation
------------

.. code:: bash

    $ pip install folium-offline

Functionality should be consistent with folium.  See Folium's documentation for syntax, and examples.  
