Welcome to pyi2ncommon's documentation!
=======================================
-This library is intended to hold python helper code used everywhere in Intra2net code. It is starting small but will surely grow...
+This library has two main purposes:
+ (1) provide an interface to external python code (i.e., code not running
+ inside a Intra2net system, most notably QA tests) to some of the internal
+ workings of Intra2net systems. This includes:
+ - the configuration system (module :py:mod:`pyi2ncommon.cnfvar`)
+ - interactions with the central daemon (:py:mod:`pyi2ncommon.arnied_api`,
+ :py:mod:`pyi2ncommon.arnied_wrapper`)
+ - interactions with the connection daemon (:py:mod:`pyi2ncommon.dial`, :py:mod:`pyi2ncommon.connd_state`)
+ (2) provide helpers for internal source code, to simplify creating tests or helper scripts in python
+ that run inside an Intra2net-system. Featuring: :py:mod:`pyi2ncommon.argparse_helpers`,
+ :py:mod:`pyi2ncommon.buffers`, :py:mod:`pyi2ncommon.iter_helpers`, :py:mod:`pyi2ncommon.log_helpers`,
+ :py:mod:`pyi2ncommon.log_read`, :py:mod:`pyi2ncommon.text_helpers`
+
+The selection of modules listed here is not complete; modules are not "tied" to one of these two
+purposes, most modules can be used inside or outside an Intra2net system.
+
Contents:
BuildRequires: python3-setuptools
%description
-Helper modules for Intra2net source code that are used in several places and/or are of general interest
+Python interface to some internal workings of Intra2net systems plus internal helpers
%package -n python3-%{name}
Summary: Intra2net library of common helper utilities
Group: Development/Languages
%description -n python3-%{name}
-Helper modules for Intra2net source code that are used in several places and/or are of general interest
+Python interface to some internal workings of Intra2net systems plus internal helpers
%prep
%setup -q