If you are trying to debug something like:
  ImportError: No module named ntp
you have come to the right place.

The default location where we install our python libraries is
  /usr/local/lib/pythonX.Y/site-packages/
where X and Y are the python version numbers.

Unfortunately, that's not on the default search path of several
OSes/distros, in particular Fedora and NetBSD.


Python has a search path that is used to find library modules when
you import them.  You can see your search path with:
  python2 -c "import sys; print sys.path"
or
  python3 -c "import sys; print(sys.path)"

Info on Python's search path:
  https://docs.python.org/2/tutorial/modules.html
or
  https://docs.python.org/3/tutorial/modules.html



There are several ways to make things work.

1: You can modify the location where waf will install the libraries.
For NetBSD, something like this should work:
  ./waf configure \
    --pythondir=/usr/pkg/lib/python2.7/site-packages \
    --pythonarchdir=/usr/pkg/lib/python2.7/site-packages \
    ...
You need to specify it at configure time.  Install time is too late.


2: You can setup your PYTHONPATH with something like this:
  export PYTHONPATH=/usr/local/lib/python2.7/site-packages
For bash, you can add that line to your .bashrc or the system /etc/bashrc
If you don't put it in the system file, all users will have to do this,
including root if root uses any ntp scripts.


3: You can add to the default search path by setting up a .pth file
with something like this:
  echo /usr/local/lib/python2.7/site-packages > \
    /usr/lib/python2.7/site-packages/ntpsec.pth
This works for all users, including root.
Note that the pth file must be on the default Python search path.


OTOH if you run into something like:
    Traceback (most recent call last):
      File "/usr/bin/ntpdig", line 419, in <module>
        timeout=timeout)
      File "/usr/bin/ntpdig", line 109, in queryhost
        keyid, keytype, passwd)
      File "/usr/lib/python3/dist-packages/ntp/packet.py", line 1747, in compute_mac
        if not ntp.ntpc.checkname(keytype):
    AttributeError: module 'ntp.ntpc' has no attribute 'checkname'

Then you probably want to either uninstall the previous Python extension, or
install one after 1.1.9 (798b93) by adding the '--enable-pylib ext' option
without quotes.

OTOH if you are running into something like:
    Traceback (most recent call last):
    File "/usr/bin/ntpdig", line 19, in <module>
        import ntp.packet
    File "/usr/lib/python3/dist-packages/ntp/packet.py", line 219, in <module>
        import ntp.ntpc
    File "/usr/lib/python3/dist-packages/ntp/ntpc.py", line 52, in <module>
        _ntpc = _importado()
    File "/usr/lib/python3/dist-packages/ntp/ntpc.py", line 38, in _importado
        return _dlo(ntpc_paths)
    File "/usr/lib/python3/dist-packages/ntp/ntpc.py", line 49, in _dlo
        raise OSError("Can't find %s library" % LIB)
    OSError: Can't find ntpc library

That means is that ntpc.py looked for libnptc.so in the usual places and could
not find it.  If it is being installed to the wrong location on your platform,
you can correct the install location using: waf configure --libdir=  If you
are intentionally installing to a non-default location, you can modify the
dynamic linker's search path globally (e.g. /etc/ld.so.conf or
/etc/ld.so.conf.d/) or in your environment (e.g. LD_LIBRARY_PATH).

On some platforms, it is necessary to run ldconfig after installing libraries.
This is normally done by the waf install step, but it may have failed.  When
using a temporary --destdir (e.g. as part of package builds), ldconfig must be
run manually after the library is installed to its final location.

= The NTPsec distribution base directory =

This directory and its subdirectories contain NTPSec, a
security-hardened implementation of Network Time Protocol Version 4.
You can browse a summary of differences from legacy NTP here:

https://docs.ntpsec.org/latest/ntpsec.html

The contents of the base directory are given in this file. The contents of
subdirectories are usually given in the README files in each subdirectory.

The base directory ./ contains the configuration files, source
directories and related stuff:

INSTALL.adoc::	Generic installation instructions.

LICENSE.adoc::	Software licensing agreement.

NEWS.adoc::	What's new in this release.

README.adoc::	This file.

VERSION::	The version stamp, to be used by scripts and programs.

lgtm.template.yml:: Configuration file for LGTM code analysis

attic/::	Directory containing source code that is *not* part of a
		normal installation. Things can disappear from here at any
		time.

buildprep::	Executable script for fetching installation prerequisites.

contrib/::	Directory containing contributed scripts, dragons dwell here.
		Some of this might eventually move to being supported code.

devel/::	Documentation and small tools aimed at developers.
		Includes a hacking guide and a tour of the internals.

docs/::		Directory containing a complete set of documentation on
		building and configuring a NTP server or client. The files
		are in asciidoc markup.  This replaces the 'html' directory
		of previous versions, but html can be generated from it.

etc/::		Directory containing a motley collection of configuration files
		and launch scripts for various systems. For example
		only.

include/::	Directory containing include header files used by most
		programs in the distribution.

libjsmn/::	A minimal JSON library used by the GPSD-JSON driver.

libntp/::	Directory containing library source code used by most
		programs in the distribution.

libparse/::	This directory contains the files making up the parser for
		the parse refclock driver. For reasonably sane clocks
		this refclock drivers allows a refclock implementation
		by just providing a conversion routine and the
		appropriate NTP parameters

ntpclients/::   Directory containing sources for clients - utility programs
		to query local and remote NTP installations for log status,
		state variables, and other timekeeping information.  The term
		"clients" is used quite loosely here; any tool that is not a
		multi-file C program probably lives in this directory.

ntpd/::		Sources for the main time-synchronization daemon.

ntpfrob/::      The ntpfrob utility collects several small diagnostic
		functions for reading and tweaking the local clock
		hardware, including reading the clock tick rate,
		precision, and jitter.

ntptime/::	Directory containing a utility for reading and modifying
		kernel parameters related to the local clock.

packaging/::	Parts and guidance for distribution packagers.

pylib/::	Installable Python helper modules for scripts.

tests/::	Self-test code.

waf::		A copy of the waf builder.  This is the engine used to configure
		and build the codebase.

wafhelpers/::	A library of Python procedures used by the waf build system.

wscript::	NTP-specific waf rules.

www/::		Sample ntpviz files

// end