add links to official secondary importance file

[nominatim.git] / docs / library / Getting-Started.md

diff --git a/docs/library/Getting-Started.md b/docs/library/Getting-Started.md
index 77724e67c7212d4d5b788d2d307a13156ae30dad..dd16b11dee09bf21aff8bb7f8c2db8ab853670ac 100644 (file)
--- a/docs/library/Getting-Started.md
+++ b/docs/library/Getting-Started.md
@@ -3,8 +3,7 @@
 The Nominatim search frontend can directly be used as a Python library in
 scripts and applications. When you have imported your own Nominatim database,
 then it is no longer necessary to run a full web service for it and access
 The Nominatim search frontend can directly be used as a Python library in
 scripts and applications. When you have imported your own Nominatim database,
 then it is no longer necessary to run a full web service for it and access

-the database through http requests. With the Nominatim library it is possible
-to access all search functionality directly from your Python code. There are
+the database through http requests. There are

 also less constraints on the kinds of data that can be accessed. The library
 allows to get access to more detailed information about the objects saved
 in the database.
 also less constraints on the kinds of data that can be accessed. The library
 allows to get access to more detailed information about the objects saved
 in the database.


@@ -14,21 +13,21 @@ in the database.
     be some smaller adjustments to the public interface until the next version.
 
     The library also misses a proper installation routine, so some manipulation
     be some smaller adjustments to the public interface until the next version.
 
     The library also misses a proper installation routine, so some manipulation

-    of the PYTHONPATH is required. Use is only recommended for advanced Python
-    programmers at the moment.
+    of the PYTHONPATH is required. At the moment, use is only recommended for
+    developers with some experience in Python.

 
 ## Installation
 
 To use the Nominatim library, you need access to a local Nominatim database.
 
 ## Installation
 
 To use the Nominatim library, you need access to a local Nominatim database.

-Follow the [installation and import instructions](../admin/) to set up your
-database.
+Follow the [installation](../admin/Installation.md) and
+[import](../admin/Import.md) instructions to set up your database.

 
 It is not yet possible to install it in the usual way via pip or inside a
 virtualenv. To get access to the library you need to set an appropriate
 
 It is not yet possible to install it in the usual way via pip or inside a
 virtualenv. To get access to the library you need to set an appropriate

-PYTHONPATH. With the default installation, the python library can be found
+`PYTHONPATH`. With the default installation, the python library can be found

 under `/usr/local/share/nominatim/lib-python`. If you have installed
 Nominatim under a different prefix, adapt the `/usr/local/` part accordingly.
 under `/usr/local/share/nominatim/lib-python`. If you have installed
 Nominatim under a different prefix, adapt the `/usr/local/` part accordingly.

-You can also point the PYTHONPATH to the Nominatim source code.
+You can also point the `PYTHONPATH` to the Nominatim source code.

 
 ### A simple search example
 
 
 ### A simple search example
 


@@ -36,7 +35,7 @@ To query the Nominatim database you need to first set up a connection. This
 is done by creating an Nominatim API object. This object exposes all the
 search functions of Nominatim that are also known from its web API.
 
 is done by creating an Nominatim API object. This object exposes all the
 search functions of Nominatim that are also known from its web API.
 

-This code snippet implements a simple search for the town if 'Brugge':
+This code snippet implements a simple search for the town of 'Brugge':

 
 !!! example
     === "NominatimAPIAsync"
 
 !!! example
     === "NominatimAPIAsync"


@@ -55,7 +54,7 @@ This code snippet implements a simple search for the town if 'Brugge':
         if not results:
             print('Cannot find Brugge')
         else:
         if not results:
             print('Cannot find Brugge')
         else:

-            print(f'Found a place at {results[0].centroid.x},{results[1].centroid.y}')
+            print(f'Found a place at {results[0].centroid.x},{results[0].centroid.y}')

         ```
 
     === "NominatimAPI"
         ```
 
     === "NominatimAPI"


@@ -71,7 +70,7 @@ This code snippet implements a simple search for the town if 'Brugge':
         if not results:
             print('Cannot find Brugge')
         else:
         if not results:
             print('Cannot find Brugge')
         else:

-            print(f'Found a place at {results[0].centroid.x},{results[1].centroid.y}')
+            print(f'Found a place at {results[0].centroid.x},{results[0].centroid.y}')

         ```
 
 The Nominatim library is designed around
         ```
 
 The Nominatim library is designed around


@@ -83,8 +82,8 @@ significantly.
 For smaller scripts there is also a synchronous wrapper around the API. By
 using `NominatimAPI`, you get exactly the same interface using classic functions.
 
 For smaller scripts there is also a synchronous wrapper around the API. By
 using `NominatimAPI`, you get exactly the same interface using classic functions.
 

-The examples in this chapter will always show how work with both of the
-implementations. The documentation itself will refer usually only to
+The examples in this chapter will always show-case both
+implementations. The documentation itself will usually refer only to

 'Nominatim API class' when both flavours are meant. If a functionality is
 available only for the synchronous or asynchronous version, this will be
 explicitly mentioned.
 'Nominatim API class' when both flavours are meant. If a functionality is
 available only for the synchronous or asynchronous version, this will be
 explicitly mentioned.


@@ -104,7 +103,7 @@ You should have set up this directory as part of the Nominatim import.
 Any configuration found in the `.env` file in this directory will automatically
 used.
 
 Any configuration found in the `.env` file in this directory will automatically
 used.
 

-The second way to configure your Nominatim setup is through environment variables.
+Yo may also configure Nominatim be setting environment variables.

 Normally, Nominatim will check the operating system environment. This can be
 overwritten by giving the constructor a dictionary of configuration parameters.
 
 Normally, Nominatim will check the operating system environment. This can be
 overwritten by giving the constructor a dictionary of configuration parameters.
 


@@ -209,8 +208,8 @@ results should be presented. As with the names in the result itself, the
 places in `address_rows` contain all possible name translation for each row.
 
 The library has a helper class `Locale` which helps extracting a name of a
 places in `address_rows` contain all possible name translation for each row.
 
 The library has a helper class `Locale` which helps extracting a name of a

-place in the preferred language. It gets a list of language code in the
-order of preference. So
+place in the preferred language. It takes a single parameter with a list
+of language codes in the order of preference. So

 
 ``` python
 locale = napi.Locale(['fr', 'en'])
 
 ``` python
 locale = napi.Locale(['fr', 'en'])


@@ -220,7 +219,7 @@ creates a helper class that returns the name preferably in French. If that is
 not possible, it tries English and eventually falls back to the default `name`
 or `ref`.
 
 not possible, it tries English and eventually falls back to the default `name`
 or `ref`.
 

-The Locale object can be applied to a name dictionary to return the best-matching
+The `Locale` object can be applied to a name dictionary to return the best-matching

 name out of it:
 
 ``` python
 name out of it:
 
 ``` python