jaraco.packaging


Namejaraco.packaging JSON
Version 10.1.0 PyPI version JSON
download
home_pagehttps://github.com/jaraco/jaraco.packaging
Summarytools to supplement packaging Python releases
upload_time2024-04-19 19:41:27
maintainerNone
docs_urlNone
authorJason R. Coombs
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            .. image:: https://img.shields.io/pypi/v/jaraco.packaging.svg
   :target: https://pypi.org/project/jaraco.packaging

.. image:: https://img.shields.io/pypi/pyversions/jaraco.packaging.svg

.. image:: https://github.com/jaraco/jaraco.packaging/actions/workflows/main.yml/badge.svg
   :target: https://github.com/jaraco/jaraco.packaging/actions?query=workflow%3A%22tests%22
   :alt: tests

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

.. image:: https://readthedocs.org/projects/jaracopackaging/badge/?version=latest
   :target: https://jaracopackaging.readthedocs.io/en/latest/?badge=latest

.. image:: https://img.shields.io/badge/skeleton-2024-informational
   :target: https://blog.jaraco.com/skeleton

Tools for packaging.


sphinx
======

This package provides a Sphinx extension that will inject into the config
the following values from the project's package metadata (as presented by
distutils):

 - project (from name)
 - author
 - copyright (same as author)
 - version
 - release (same as version)
 - package_url (from url)

To enable, include 'jaraco.packaging' in the requirements and add
'jaraco.packaging.sphinx' to the list of extensions in a Sphinx config
file::

    extensions=['jaraco.packaging.sphinx']

The extension by default builds the project in an isolated environment in
order to extract the metadata. For offline builds, set
``BUILD_ENVIRONMENT=current`` and ensure the build dependencies are
met in the current environment.

Deprecated: To build the documentation offline,
provide an already built wheel by setting the environment variable
``JARACO_PACKAGING_SPHINX_WHEEL`` to the path of an existing wheel.


make-tree
=========

A utility for taking output from ``pipdeptree --json`` and producing a tree
rooted at a given package.

Usage::

    pipdeptree --json | python -m jaraco.packaging.make-tree mypkg


metadata
=========

A wrapper around ``build.util.project_wheel_metadata`` to enable dowstream
packagers to indicate that they need an isolated build. Set the environment
variable ``BUILD_ENVIRONMENT=current`` to bypass build isolation and use the
current isolation for loading metadata from a project.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jaraco/jaraco.packaging",
    "name": "jaraco.packaging",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Jason R. Coombs",
    "author_email": "jaraco@jaraco.com",
    "download_url": "https://files.pythonhosted.org/packages/dd/3d/4efa664ef6f8eea7b7ced35ab95787ee4da5ad020f75a7da78e67c543f6f/jaraco_packaging-10.1.0.tar.gz",
    "platform": null,
    "description": ".. image:: https://img.shields.io/pypi/v/jaraco.packaging.svg\n   :target: https://pypi.org/project/jaraco.packaging\n\n.. image:: https://img.shields.io/pypi/pyversions/jaraco.packaging.svg\n\n.. image:: https://github.com/jaraco/jaraco.packaging/actions/workflows/main.yml/badge.svg\n   :target: https://github.com/jaraco/jaraco.packaging/actions?query=workflow%3A%22tests%22\n   :alt: tests\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Ruff\n\n.. image:: https://readthedocs.org/projects/jaracopackaging/badge/?version=latest\n   :target: https://jaracopackaging.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/badge/skeleton-2024-informational\n   :target: https://blog.jaraco.com/skeleton\n\nTools for packaging.\n\n\nsphinx\n======\n\nThis package provides a Sphinx extension that will inject into the config\nthe following values from the project's package metadata (as presented by\ndistutils):\n\n - project (from name)\n - author\n - copyright (same as author)\n - version\n - release (same as version)\n - package_url (from url)\n\nTo enable, include 'jaraco.packaging' in the requirements and add\n'jaraco.packaging.sphinx' to the list of extensions in a Sphinx config\nfile::\n\n    extensions=['jaraco.packaging.sphinx']\n\nThe extension by default builds the project in an isolated environment in\norder to extract the metadata. For offline builds, set\n``BUILD_ENVIRONMENT=current`` and ensure the build dependencies are\nmet in the current environment.\n\nDeprecated: To build the documentation offline,\nprovide an already built wheel by setting the environment variable\n``JARACO_PACKAGING_SPHINX_WHEEL`` to the path of an existing wheel.\n\n\nmake-tree\n=========\n\nA utility for taking output from ``pipdeptree --json`` and producing a tree\nrooted at a given package.\n\nUsage::\n\n    pipdeptree --json | python -m jaraco.packaging.make-tree mypkg\n\n\nmetadata\n=========\n\nA wrapper around ``build.util.project_wheel_metadata`` to enable dowstream\npackagers to indicate that they need an isolated build. Set the environment\nvariable ``BUILD_ENVIRONMENT=current`` to bypass build isolation and use the\ncurrent isolation for loading metadata from a project.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "tools to supplement packaging Python releases",
    "version": "10.1.0",
    "project_urls": {
        "Homepage": "https://github.com/jaraco/jaraco.packaging"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f45fde7fe7b5390e698e81e42e8236d9d5a592200b2cc95aeadbd98ce0976523",
                "md5": "64d6ef28d691967747a0628f0ce8dda2",
                "sha256": "d2927068083355cee9e0954c37872da10b5eee212e866c58125115a2d399c390"
            },
            "downloads": -1,
            "filename": "jaraco.packaging-10.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64d6ef28d691967747a0628f0ce8dda2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6794,
            "upload_time": "2024-04-19T19:41:20",
            "upload_time_iso_8601": "2024-04-19T19:41:20.647459Z",
            "url": "https://files.pythonhosted.org/packages/f4/5f/de7fe7b5390e698e81e42e8236d9d5a592200b2cc95aeadbd98ce0976523/jaraco.packaging-10.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd3d4efa664ef6f8eea7b7ced35ab95787ee4da5ad020f75a7da78e67c543f6f",
                "md5": "d372127789ce8d952bbb0928c51eb67a",
                "sha256": "e53971c48a2d9e9abe2dde080b9504de4cc21603243fe338be8de640e9dd8be3"
            },
            "downloads": -1,
            "filename": "jaraco_packaging-10.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d372127789ce8d952bbb0928c51eb67a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 13027,
            "upload_time": "2024-04-19T19:41:27",
            "upload_time_iso_8601": "2024-04-19T19:41:27.329594Z",
            "url": "https://files.pythonhosted.org/packages/dd/3d/4efa664ef6f8eea7b7ced35ab95787ee4da5ad020f75a7da78e67c543f6f/jaraco_packaging-10.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-19 19:41:27",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jaraco",
    "github_project": "jaraco.packaging",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "jaraco.packaging"
}
        
Elapsed time: 0.23930s