fix linting issues

disable warning about non-toplevel import

They are needed here so nominatim can be run when osmium
is not installed. Everything except replication will work fine.

introduce custom UsageError

This is a exception to be thrown when the error occures because
of bad user data. We don't want to print a full stack trace in
these cases but just tell the user what went wrong.

remove setting for PYOSMIUM_BINARY

pyosmium is now called as a library from the python code,
so that pyosmium-get-changes is no longer needed.

whitelist pyosmium for pylint

port replication update function to python

port check-for-update function to python

port replication initialisation to Python

convert functon creation to python

The new functions always creates normal and partitioned functions.
Also adds specialised connection and cursor classes for adding
frequently used helper functions.

port address level computation to Python

Also adds simple tests for correct table creation.

move update code for postcode and word count to Python

Adds also tests for the new function to execute a SQL script.

cli: import python modules for commands on demand

Given that only one command will be executed in the end, it is
not necessary to import what amounts to the whole library. This
becomes in particular important for update functions that have
a dependency on pyosmium. The dependency can remain optional for
people not using updates.

remove API comparison util

This is outdated and unmaintained. There are tools out there
which can do this better. Try, for example
https://github.com/radarlabs/api-diff

Merge pull request #2147 from lonvia/tests-for-python-code

Add basic set of tests for Python code

cli indexer tests need a fake database

The Indexer constructor opens a connection to the given database.

add more tests for CLI parameter parser

add tests for indexer

add simple tests for CLI parsing

optionally hand in command line arguments to CLI functions

Allows easier testing.

use pytest mocking functions for manipulating os.environ

add tests for Python exec_utils

Merge pull request #2146 from mtmail/two-typos

correct parameter name in query CLI

correct parameter name in query CLI

Merge pull request #2145 from lonvia/cli-query-functions

Add interface to search via command line tool

add API functions to nominatim tool

rename nominatim.admin to nominatim.tools

probe for php_cgi in cmake to be used for querying

Merge pull request #2143 from lonvia/integrate-indexer-into-nominatim-tool

Integrate indexer into nominatim tool

remove old nominatim.py in favour of 'nominatim index'

The PHP scripts need to know the position of the nominatim
tool in order to call it. This is handed in as environment
variable, so it can be set by the Python script.

implementaion of 'nominatim index'

move indexing function into its own Python module

This makes it mow a standard function of our new Python
library instead of a stand-alone program.

add function to get a DSN for psycopg

Converts the PHP DSN syntax into psycopg syntax when necessary.

Merge pull request #2142 from lonvia/update-bdd-api-tests

Update BDD API tests

bdd: complete coverage for API tests

Also removes some functions that are no longer used and
fixes debug output where the tests found an issue.

remove unused output formatting functions

bdd: remove duplicated tests

bdd: clean up and extend API tests for details

- remove duplicates created by replacing HTML tests
  with JSON tests
- add tests for newer functions for returning geometries
  and hierarchies

collect coverage for /website directory as well

Merge pull request #2139 from lonvia/add-pytest

Introduce unit testing for Python code

pytest may also be installed as py-test[-3]

enable pytest testing in CI

add documentation for new pytest tests

add pytest as a test goal in cmake

add initial pytest test for Configuration

Merge pull request #2136 from lonvia/introduce-pylint

Introduce pylint for code style checking for Python.

pylint may be available as pylint3 or pylint

use check parameter of subprocess.run

...instead of checking on our own.

Also increase required version of Python to 3.5 because of
subprocess.run().

add pylint to list of required linting tools

With pylint being run in the CI, passing it is required now.

fix errors reported by pylint

Merge pull request #2135 from lonvia/python-frontend

Introduce new 'nominatim' all-in-one command-line tool

fix typo

replace Symfony dotenv dependency with Python dotenv

bdd: directly call utility scripts in lib

This removes the dependency on php-symfony-dotenv for the tests.

move dotenv parsing to installed PHP scripts

This means that the php-symfony-dotenv library is now only needed
when using the legacy scripts. This includes the BDD tests which
currently still rely on the PHP utils.

use cli tool for github CI

forward cli tool return value as exit code

adapt documentation to new nominatim cli tool

maller command execution fixes

make sure that environment variables have highest prio

liniting of new python code

add wrapper calls for all nominatim tool functions

avoid accessing constants when getting data from env

When a setting can be read from the environment variable, avoid
accessing the internal defaults. This way the scripts can be
accessed directly in \lib as long as the environment is set up
correctly with full defaults.

fix access to environment variable

implement warming in new cli tool

Adds infrastructure for calling the legacy PHP scripts. As the
CONST_* values cannot be set from the python script, hand the values
in via secret environment variables instead. These are all
temporary hacks for the transition phase to python code.

warm.php needs constant setup for queries

Warming is done using the query classes and therefore the same
copy-over from dotenv settings to CONST_* parameters is needed
as for query.php.

set CONST_LibDir directly from the source scripts

Now that the source scripts have been moved to \lib, they
can determine the position of the PHP library relative to
themselves.

move PHP utilities into the lib directory

These are not called directly as programs but used in a library
fashion by the installed utilities. So the library directory
is a better place.

consolidate cli interface to single tool

create skeleton for new CLI tools

add skeleton for new Nominatim executables

Merge pull request #2132 from lonvia/reduce-api-testdb

Reduce BDD API test database to Liechtenstein

also run BDD API tests in CI

test can be run all in one go with make

update documentation for new BDD API tests

bdd: add new API test data

Make all data necessary for API tests directly available in the
repository.

bdd: convert API tests to smaller test db

Changes BDD API tests to restrict themselves to
Liechtenstein. One test moved to DB as no appropriate
data is available.

bdd: improve assert output for API query checks

Adds wrapper function for checking address parts and
more explanation strings to asserts.

bdd: import API test DB as part of step setup

In the future, the BDD tests will simply set up the required
test database themselves. Like with the template database, it
is not reimported when it already exists unless that is explicitly
forced.

Makes most of the API tests currently fail because they still
point to old test data.

Merge pull request #2129 from lonvia/cleanup-bdd-tests

Clean up Python support code for BDD tests

add symphony dotenv to prerequisites list

use relative dir for sources for phpunit

bdd: clean up DB ops steps

Adds comments and modernizes code.

bdd: move column comparison in separate file

Introduces a new class DBRow that encapsulates the comparison
functions. This also is responsible for formatting more informative
assert messages. place and placex steps are unified.

bdd: move nominitim id reader to separate file

bdd: factor out reindexing on updates

bdd: move place table inserter into separate file

Also simplifies usage by implementing a function that inserts
a complete table row.

bdd: move scene setup to OSM data steps

The step has nothing to do with the database.

bdd: switch to auto commit mode

Put the connection to the test database into auto-commit mode
and get rid of the explicit commits. Also use cursors always in
context managers and unify the two implementations that copy
data from the place table.

bdd: remove class for lazy formatting

assert in combination with format() does the right thing and calls
the __str__() method only when an assertion hits.

bdd: rename db_ops steps

Now all files implementing steps are called steps_*.py.

bdd: move output format computation into response

bdd: move Response classes in own file and simplify

Removes most of the duplicated parse functions, introduces
a common assert_field function with a more expressive error
message.

bdd: rename and clean up osm_data steps

Move common OPL creation code into a function and remove
unused imports.

bdd: move external process execution in separate func

bdd: move NominatimEnvironment into separate file

Also cleans up and modernizes the code and adds documentation.

bdd: move grid generation code into geometry factory

bdd: move geoemtry creation into separate file

Also renames the OsmDataFactory in the more appropriate
GeometryFactory and modernizes code for python3.

remove stale code for python2

Merge pull request #2125 from lonvia/independent-project-directory

Allow for truely independent project directory

create a temporary project dir for tests

The project directory contains the website script as
configured through the test configuration. This means
that tests are now completely independet of any
configuration that may be contained in the build
directory.

Also removes the hack to inject additional settings via
a environment variable.