Metadata-Version: 2.4
Name: package-smoke-test
Version: 1.1.0
Summary: Simple import test for Python packages
Author-email: Ben Finney <ben+python@benfinney.id.au>
Maintainer: Ben Finney
Maintainer-email: ben+python@benfinney.id.au
License-Expression: AGPL-3.0-or-later
Project-URL: Homepage, https://salsa.debian.org/bignose/python-package-smoke-test/
Project-URL: Issue tracker, https://bugs.debian.org/
Project-URL: Change log, https://salsa.debian.org/bignose/python-package-smoke-test/-/raw/main/ChangeLog
Keywords: test,smoke,packaging
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.GPL-3
Provides-Extra: static-analysis
Requires-Dist: pip-check; extra == "static-analysis"
Requires-Dist: mccabe~=0.7; extra == "static-analysis"
Requires-Dist: pycodestyle~=2.15; extra == "static-analysis"
Requires-Dist: ruff~=0.17; extra == "static-analysis"
Provides-Extra: test
Requires-Dist: changelog-chug[static-analysis]; extra == "test"
Provides-Extra: devel
Requires-Dist: changelog-chug[test]; extra == "devel"
Requires-Dist: pyupgrade~=3.22; extra == "devel"
Requires-Dist: isort~=9.0; extra == "devel"
Provides-Extra: build
Requires-Dist: changelog-chug[devel]; extra == "build"
Requires-Dist: wheel; extra == "build"
Requires-Dist: build; extra == "build"
Provides-Extra: publish
Requires-Dist: changelog-chug[build]; extra == "publish"
Requires-Dist: twine; extra == "publish"
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email

#########################
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]
    Module ‘dolor’:
            <module 'dolor' from '/usr/lib/python3/dist-packages/lorem/dolor/__init__.py'>
    Module ‘sit’:
            <module 'sit' from '/usr/lib/python3/dist-packages/lorem/sit/__init__.py'>
    Module ‘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: text
    mode: rst
    End:
    vim: fileencoding=utf-8 filetype=rst :
