File: README

package info (click to toggle)
python-package-smoke-test 1.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 160 kB
  • sloc: python: 62; makefile: 5
file content (74 lines) | stat: -rw-r--r-- 2,337 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#########################
python-package-smoke-test
#########################

Simple import test for Python packages
######################################

This library implements a set of simple verification tests for an installed
Python distribution, or an installed Python module.


Examples
========

Verify installation of a Python distribution
--------------------------------------------

To verify correct installation of a Python distribution named `lorem`::

    $ python3 -m package_smoke_test --distribution lorem
    Interpreter: /usr/bin/python3
            3.11.4 (main, Jun  7 2023, 10:13:09) [GCC 12.2.0]
    Distribution ‘lorem’:
            Lorem Ipsum 2.7.3


Verify installation of Python packages or modules
-------------------------------------------------

To verify correct installation of a set of Python packages or modules, named
`dolor`, `sit`, and `amet`::

    $ python3 -m package_smoke_test --module dolor sit amet
    Interpreter: /usr/bin/python3
            3.11.4 (main, Jun  7 2023, 10:13:09) [GCC 12.2.0]
    Package ‘dolor’:
            <module 'dolor' from '/usr/lib/python3/dist-packages/lorem/dolor/__init__.py'>
    Package ‘sit’:
            <module 'sit' from '/usr/lib/python3/dist-packages/lorem/sit/__init__.py'>
    Package ‘amet’:
            <module 'amet' from '/usr/lib/python3/dist-packages/lorem/amet/__init__.py'>


Example script for post-installation test
-----------------------------------------

The file ``doc/examples/smoke-test-python3`` is a Bash script that you can
customise for your package, to run the above tests.


Copying
=======

This work, ‘python-package-smoke-test’, is free software: you may copy, modify,
and/or distribute this work under the conditions of the GNU General Public
License as published by the Free Software Foundation; version 3 of that license
or any later version. See the file ‘LICENSE.GPL-3’ for details.
No warranty expressed or implied.


..
    This document is written using `reStructuredText`_ markup, and can
    be rendered with `Docutils`_ to other formats.

    ..  _Docutils: https://docutils.sourceforge.io/
    ..  _reStructuredText: https://docutils.sourceforge.io/rst.html

..
    Local variables:
    coding: utf-8
    mode: rst
    mode: text
    End:
    vim: fileencoding=utf-8 filetype=rst :