pkg-about


Namepkg-about JSON
Version 1.4.0 PyPI version JSON
download
home_pageNone
SummaryShares Python package metadata at runtime.
upload_time2025-08-18 11:27:52
maintainerAdam Karpierz
docs_urlNone
authorAdam Karpierz
requires_python<4.0.0,>=3.10.0
licenseNone
keywords pkg_about __about__ packaging
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            pkg_about
=========

Shares Python package metadata at runtime.

Overview
========

TBD...

`PyPI record`_.

`Documentation`_.

Usage
-----

TBD...

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>

.. |package| replace:: pkg_about
.. |package_bold| replace:: **pkg_about**
.. |copyright| replace:: Copyright (c) 2020-2025 Adam Karpierz
.. |respository| replace:: https://github.com/karpierz/pkg_about.git
.. _Development page: https://github.com/karpierz/pkg_about
.. _PyPI record: https://pypi.org/project/pkg-about/
.. _Documentation: https://pkg-about.readthedocs.io/

Changelog
=========

1.4.0 (2025-08-15)
------------------
- | Now about_from_setup() returns an instance of the 'about' class
  | (but backward compatibility is preserved).
- Making the package typed.
- Setup (dependencies) update.

1.3.7 (2025-07-07)
------------------
- Use standard importlib.metadata instead of importlib-metadata.
- Setup (dependencies) update.

1.3.6 (2025-06-11)
------------------
- Setup (dependencies) update.

1.3.5 (2025-05-15)
------------------
- | The 'License-Expression' metadata field takes precedence over the
  | 'License' metadata field.
- The distribution is now created using 'build' instead of 'setuptools'.
- Setup (dependencies) update (due to regressions in tox and setuptools).

1.3.3 (2025-05-04)
------------------
- Setup (dependencies) update.

1.3.1 (2025-05-01)
------------------
- Add support for Python 3.14
- Drop support for Python 3.9 (due to compatibility issues).
- Update readthedocs's python to version 3.13
- Update tox's base_python to version 3.13
- | Remove the ability to obtain __copyright__ from the README.rst or
  | __about__.py due to significant compatibility issue(s) (because the
  | 'Copyright' field is not a member of the package metadata at all).
  | For now, the __copyright__ field is the same as __author__ field
  | (which is always obtained from the package metadata).
- Remove dependencies on docutils.
- Setup (dependencies) update.

1.2.11 (2025-03-20)
-------------------
- Add support for PyPy 3.11
- Drop support for PyPy 3.9
- Setup (dependencies) update.

1.2.10 (2025-03-15)
-------------------
- Setup (dependencies) update.

1.2.9 (2025-02-14)
------------------
- Setup (dependencies) update.

1.2.8 (2025-01-25)
------------------
- Setup (dependencies) update.

1.2.7 (2025-01-20)
------------------
- Copyright year update.
- Setup (dependencies) update.

1.2.6 (2024-12-13)
------------------
- Source distribution (\*.tar.gz now) is compliant with PEP-0625.
- Setup (dependencies) update.

1.2.5 (2024-11-13)
------------------
- More unittests.
- 100% code linting.
- 100% code coverage.
- Tox configuration is now in native (toml) format.
- Setup (dependencies) update.

1.2.2 (2024-10-30)
------------------
- Setup (dependencies) update.

1.2.0 (2024-09-30)
------------------
- Drop support for Python 3.8
- Ability to obtain __copyright__ from the README.rst content.
- Setup (dependencies) update.

1.1.8 (2024-08-13)
------------------
- Add support for Python 3.13
- Setup (dependencies) update.

1.1.7 (2024-07-15)
------------------
- Setup (dependencies) update.

1.1.6 (2024-06-20)
------------------
- Setup (dependencies) update.

1.1.5 (2024-01-26)
------------------
- Setup update (now based on tox >= 4.0).
- Cleanup.

1.1.0 (2023-12-15)
------------------
- Add support for Python 3.12
- Drop support for Python 3.7
- Add support for PyPy 3.10
- Drop support for PyPy 3.7 and 3.8
- Bugfix for parsing metadata's 'Project-URL'.
- Bugfix of about_from_setup() for __version_info__.
- | Enhancement: the 'package_path' parameter of the about_from_setup()
  | can now be of type string or Path.
- Bugfix of about_from_setup() for parsing author and maintainer emails.
- Copyright year update.
- Added a trivial unit test.

1.0.8 (2022-10-18)
------------------
- Tox configuration has been moved to pyproject.toml

1.0.7 (2022-08-22)
------------------
- Setup update.

1.0.6 (2022-07-24)
------------------
- Add __author_email__ (as alias of __email__).
- Add __maintainer_email__.
- Setup update (currently based mainly on pyproject.toml).

1.0.5 (2022-07-20)
------------------
- Add about_from_setup() (to use e.g. in docs.conf.py).
- Add support for Python 3.10 and 3.11
- Add support for PyPy 3.7, 3.8 and 3.9
- Setup update.

1.0.4 (2022-01-10)
------------------
- Drop support for Python 3.6
- Copyright year update.
- Setup update.

1.0.3 (2021-10-14)
------------------
- Setup update.

1.0.2 (2021-07-20)
------------------
- First functional release.

0.0.1 (2020-10-16)
------------------
- Initial commit.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pkg-about",
    "maintainer": "Adam Karpierz",
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.10.0",
    "maintainer_email": "adam@karpierz.net",
    "keywords": "pkg_about, __about__, packaging",
    "author": "Adam Karpierz",
    "author_email": "adam@karpierz.net",
    "download_url": "https://files.pythonhosted.org/packages/48/98/369df197b69052a606d9e805f436f8d27ac358b90895f7b313ac22f08984/pkg_about-1.4.0.tar.gz",
    "platform": "any",
    "description": "pkg_about\r\n=========\r\n\r\nShares Python package metadata at runtime.\r\n\r\nOverview\r\n========\r\n\r\nTBD...\r\n\r\n`PyPI record`_.\r\n\r\n`Documentation`_.\r\n\r\nUsage\r\n-----\r\n\r\nTBD...\r\n\r\nInstallation\r\n============\r\n\r\nPrerequisites:\r\n\r\n+ Python 3.10 or higher\r\n\r\n  * https://www.python.org/\r\n\r\n+ pip and setuptools\r\n\r\n  * https://pypi.org/project/pip/\r\n  * https://pypi.org/project/setuptools/\r\n\r\nTo install run:\r\n\r\n  .. parsed-literal::\r\n\r\n    python -m pip install --upgrade |package|\r\n\r\nDevelopment\r\n===========\r\n\r\nPrerequisites:\r\n\r\n+ Development is strictly based on *tox*. To install it run::\r\n\r\n    python -m pip install --upgrade tox\r\n\r\nVisit `Development page`_.\r\n\r\nInstallation from sources:\r\n\r\nclone the sources:\r\n\r\n  .. parsed-literal::\r\n\r\n    git clone |respository| |package|\r\n\r\nand run:\r\n\r\n  .. parsed-literal::\r\n\r\n    python -m pip install ./|package|\r\n\r\nor on development mode:\r\n\r\n  .. parsed-literal::\r\n\r\n    python -m pip install --editable ./|package|\r\n\r\nLicense\r\n=======\r\n\r\n  | |copyright|\r\n  | Licensed under the zlib/libpng License\r\n  | https://opensource.org/license/zlib\r\n  | Please refer to the accompanying LICENSE file.\r\n\r\nAuthors\r\n=======\r\n\r\n* Adam Karpierz <adam@karpierz.net>\r\n\r\n.. |package| replace:: pkg_about\r\n.. |package_bold| replace:: **pkg_about**\r\n.. |copyright| replace:: Copyright (c) 2020-2025 Adam Karpierz\r\n.. |respository| replace:: https://github.com/karpierz/pkg_about.git\r\n.. _Development page: https://github.com/karpierz/pkg_about\r\n.. _PyPI record: https://pypi.org/project/pkg-about/\r\n.. _Documentation: https://pkg-about.readthedocs.io/\r\n\r\nChangelog\r\n=========\r\n\r\n1.4.0 (2025-08-15)\r\n------------------\r\n- | Now about_from_setup() returns an instance of the 'about' class\r\n  | (but backward compatibility is preserved).\r\n- Making the package typed.\r\n- Setup (dependencies) update.\r\n\r\n1.3.7 (2025-07-07)\r\n------------------\r\n- Use standard importlib.metadata instead of importlib-metadata.\r\n- Setup (dependencies) update.\r\n\r\n1.3.6 (2025-06-11)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.3.5 (2025-05-15)\r\n------------------\r\n- | The 'License-Expression' metadata field takes precedence over the\r\n  | 'License' metadata field.\r\n- The distribution is now created using 'build' instead of 'setuptools'.\r\n- Setup (dependencies) update (due to regressions in tox and setuptools).\r\n\r\n1.3.3 (2025-05-04)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.3.1 (2025-05-01)\r\n------------------\r\n- Add support for Python 3.14\r\n- Drop support for Python 3.9 (due to compatibility issues).\r\n- Update readthedocs's python to version 3.13\r\n- Update tox's base_python to version 3.13\r\n- | Remove the ability to obtain __copyright__ from the README.rst or\r\n  | __about__.py due to significant compatibility issue(s) (because the\r\n  | 'Copyright' field is not a member of the package metadata at all).\r\n  | For now, the __copyright__ field is the same as __author__ field\r\n  | (which is always obtained from the package metadata).\r\n- Remove dependencies on docutils.\r\n- Setup (dependencies) update.\r\n\r\n1.2.11 (2025-03-20)\r\n-------------------\r\n- Add support for PyPy 3.11\r\n- Drop support for PyPy 3.9\r\n- Setup (dependencies) update.\r\n\r\n1.2.10 (2025-03-15)\r\n-------------------\r\n- Setup (dependencies) update.\r\n\r\n1.2.9 (2025-02-14)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.2.8 (2025-01-25)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.2.7 (2025-01-20)\r\n------------------\r\n- Copyright year update.\r\n- Setup (dependencies) update.\r\n\r\n1.2.6 (2024-12-13)\r\n------------------\r\n- Source distribution (\\*.tar.gz now) is compliant with PEP-0625.\r\n- Setup (dependencies) update.\r\n\r\n1.2.5 (2024-11-13)\r\n------------------\r\n- More unittests.\r\n- 100% code linting.\r\n- 100% code coverage.\r\n- Tox configuration is now in native (toml) format.\r\n- Setup (dependencies) update.\r\n\r\n1.2.2 (2024-10-30)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.2.0 (2024-09-30)\r\n------------------\r\n- Drop support for Python 3.8\r\n- Ability to obtain __copyright__ from the README.rst content.\r\n- Setup (dependencies) update.\r\n\r\n1.1.8 (2024-08-13)\r\n------------------\r\n- Add support for Python 3.13\r\n- Setup (dependencies) update.\r\n\r\n1.1.7 (2024-07-15)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.1.6 (2024-06-20)\r\n------------------\r\n- Setup (dependencies) update.\r\n\r\n1.1.5 (2024-01-26)\r\n------------------\r\n- Setup update (now based on tox >= 4.0).\r\n- Cleanup.\r\n\r\n1.1.0 (2023-12-15)\r\n------------------\r\n- Add support for Python 3.12\r\n- Drop support for Python 3.7\r\n- Add support for PyPy 3.10\r\n- Drop support for PyPy 3.7 and 3.8\r\n- Bugfix for parsing metadata's 'Project-URL'.\r\n- Bugfix of about_from_setup() for __version_info__.\r\n- | Enhancement: the 'package_path' parameter of the about_from_setup()\r\n  | can now be of type string or Path.\r\n- Bugfix of about_from_setup() for parsing author and maintainer emails.\r\n- Copyright year update.\r\n- Added a trivial unit test.\r\n\r\n1.0.8 (2022-10-18)\r\n------------------\r\n- Tox configuration has been moved to pyproject.toml\r\n\r\n1.0.7 (2022-08-22)\r\n------------------\r\n- Setup update.\r\n\r\n1.0.6 (2022-07-24)\r\n------------------\r\n- Add __author_email__ (as alias of __email__).\r\n- Add __maintainer_email__.\r\n- Setup update (currently based mainly on pyproject.toml).\r\n\r\n1.0.5 (2022-07-20)\r\n------------------\r\n- Add about_from_setup() (to use e.g. in docs.conf.py).\r\n- Add support for Python 3.10 and 3.11\r\n- Add support for PyPy 3.7, 3.8 and 3.9\r\n- Setup update.\r\n\r\n1.0.4 (2022-01-10)\r\n------------------\r\n- Drop support for Python 3.6\r\n- Copyright year update.\r\n- Setup update.\r\n\r\n1.0.3 (2021-10-14)\r\n------------------\r\n- Setup update.\r\n\r\n1.0.2 (2021-07-20)\r\n------------------\r\n- First functional release.\r\n\r\n0.0.1 (2020-10-16)\r\n------------------\r\n- Initial commit.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Shares Python package metadata at runtime.",
    "version": "1.4.0",
    "project_urls": {
        "Documentation": "https://pkg-about.readthedocs.io/",
        "Download": "https://pypi.org/project/pkg-about/",
        "Homepage": "https://pypi.org/project/pkg-about/",
        "Issues": "https://github.com/karpierz/pkg_about/issues",
        "Source": "https://github.com/karpierz/pkg_about"
    },
    "split_keywords": [
        "pkg_about",
        " __about__",
        " packaging"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cdbfbb583d0a700216a4c5ee426ad1cbd86bb60cbbf08ed9deda1df63b4a4b60",
                "md5": "642e8d632acba9076a26cc4efbcff8f1",
                "sha256": "b6e33abdb9265d44413bcc06ae6b9f4eaf58306a256e5799a8f21819ed3e9421"
            },
            "downloads": -1,
            "filename": "pkg_about-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "642e8d632acba9076a26cc4efbcff8f1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.10.0",
            "size": 6786,
            "upload_time": "2025-08-18T11:27:51",
            "upload_time_iso_8601": "2025-08-18T11:27:51.247459Z",
            "url": "https://files.pythonhosted.org/packages/cd/bf/bb583d0a700216a4c5ee426ad1cbd86bb60cbbf08ed9deda1df63b4a4b60/pkg_about-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4898369df197b69052a606d9e805f436f8d27ac358b90895f7b313ac22f08984",
                "md5": "a24937cbad09e60ca0aea8b2bd366cb9",
                "sha256": "0f795cca2b228e90c3424616475381e5d528d84ae7463995fc7f660ac0c9bb13"
            },
            "downloads": -1,
            "filename": "pkg_about-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a24937cbad09e60ca0aea8b2bd366cb9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.10.0",
            "size": 14319,
            "upload_time": "2025-08-18T11:27:52",
            "upload_time_iso_8601": "2025-08-18T11:27:52.701905Z",
            "url": "https://files.pythonhosted.org/packages/48/98/369df197b69052a606d9e805f436f8d27ac358b90895f7b313ac22f08984/pkg_about-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-18 11:27:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "karpierz",
    "github_project": "pkg_about",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pkg-about"
}
        
Elapsed time: 0.82182s