docs/library/Getting-Started.md

   1 # Getting Started
   2
   3 The Nominatim search frontend can directly be used as a Python library in
   4 scripts and applications. When you have imported your own Nominatim database,
   5 then it is no longer necessary to run a full web service for it and access
   6 the database through http requests. With the Nominatim library it is possible
   7 to access all search functionality directly from your Python code. There are
   8 also less constraints on the kinds of data that can be accessed. The library
   9 allows to get access to more detailed information about the objects saved
  10 in the database.
  11
  12 ## Installation
  13
  14 To use the Nominatim library, you need access to a local Nominatim database.
  15 Follow the [installation and import instructions](../admin/) to set up your
  16 database.
  17
  18 !!! warning
  19     Access to the library is currently still experimental. It is not yet
  20     possible to install it in the usual way via pip or inside a virtualenv.
  21     To get access to the library you need to set an appropriate PYTHONPATH.
  22     With the default installation, the python library can be found under
  23     `/usr/local/share/nominatim/lib-python`. If you have installed Nominatim
  24     under a different prefix, adapt the `/usr/local/` part accordingly.
  25     You can also point the PYTHONPATH to the Nominatim source code.
  26
  27     A proper installation as a Python library will follow in the next
  28     version.