Metadata-Version: 2.4
Name: pkg_about
Version: 2.0.11
Summary: Unified access to Python package metadata at runtime.
Author-email: Adam Karpierz <adam@karpierz.net>
Maintainer-email: Adam Karpierz <adam@karpierz.net>
License-Expression: Zlib
Project-URL: Homepage, https://pypi.org/project/pkg-about/
Project-URL: Documentation, https://karpierz.github.io/pkg_about/
Project-URL: Download, https://pypi.org/project/pkg-about/
Project-URL: History, https://karpierz.github.io/pkg_about/CHANGES.html
Project-URL: Repository, https://github.com/karpierz/pkg_about
Project-URL: Tracker, https://github.com/karpierz/pkg_about/issues
Project-URL: Sponsoring, https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S
Keywords: pkg_about,__about__,packaging
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: Polish
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: <4.0.0,>=3.10.0
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE
Requires-Dist: setuptools>=80.9.0
Requires-Dist: typing-extensions>=4.15.0
Requires-Dist: packaging>=25.0.0
Requires-Dist: tomli>=2.4.0; python_version < "3.11"
Dynamic: license-file

pkg_about
=========

Unified access to Python package metadata at runtime.

Overview
========

Provides a unified way to retrieve Python package metadata at runtime,
regardless of the build backend or project structure.

| **about(package: str)** - retrieves metadata for the given package
| **about()** - retrieves metadata for the current package
| **about_from_setup()** - retrieves metadata from pyproject.toml
                           and/or setup.cfg

`PyPI record`_.

`Documentation`_.

Usage
-----

.. code:: python

  >>> import pkg_about
  >>> pkg_about.about("pip")
  >>> __uri__ == "https://pip.pypa.io/"
  True

Installation
============

Prerequisites:

+ Python 3.10 or higher

  * https://www.python.org/

+ pip and setuptools

  * https://pypi.org/project/pip/
  * https://pypi.org/project/setuptools/

To install run:

  .. parsed-literal::

    python -m pip install --upgrade |package|

Development
===========

Prerequisites:

+ Development is strictly based on *tox*. To install it run::

    python -m pip install --upgrade tox

Visit `Development page`_.

Installation from sources:

clone the sources:

  .. parsed-literal::

    git clone |respository| |package|

and run:

  .. parsed-literal::

    python -m pip install ./|package|

or on development mode:

  .. parsed-literal::

    python -m pip install --editable ./|package|

License
=======

  | |copyright|
  | Licensed under the zlib/libpng License
  | https://opensource.org/license/zlib
  | Please refer to the accompanying LICENSE file.

Authors
=======

* Adam Karpierz <adam@karpierz.net>

Sponsoring
==========

| If you would like to sponsor the development of this project, your contribution
  is greatly appreciated.
| As I am now retired, any support helps me dedicate more time to maintaining and
  improving this work.

`Donate`_

.. |package| replace:: pkg_about
.. |package_bold| replace:: **pkg_about**
.. |copyright| replace:: Copyright (c) 2020-2026 Adam Karpierz
.. |respository| replace:: https://github.com/karpierz/pkg_about
.. _Development page: https://github.com/karpierz/pkg_about
.. _PyPI record: https://pypi.org/project/pkg-about/
.. _Documentation: https://karpierz.github.io/pkg_about/
.. _Donate: https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S
