envinfopy


Nameenvinfopy JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/thombashi/envinfopy
Summaryenvinfopy is a Python Library to get execution environment information.
upload_time2023-07-16 15:33:52
maintainer
docs_urlNone
authorTsuyoshi Hombashi
requires_python>=3.7
licenseMIT License
keywords environment uname version markdown
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. contents:: **envinfopy**
   :backlinks: top
   :depth: 2


Summary
============================================
.. image:: https://badge.fury.io/py/envinfopy.svg
    :target: https://badge.fury.io/py/envinfopy
    :alt: PyPI package version

.. image:: https://img.shields.io/pypi/pyversions/envinfopy.svg
    :target: https://pypi.org/project/envinfopy
    :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/implementation/envinfopy.svg
    :target: https://pypi.org/project/envinfopy
    :alt: Supported Python implementations

.. image:: https://github.com/thombashi/envinfopy/actions/workflows/lint_and_test.yml/badge.svg
    :target: https://github.com/thombashi/envinfopy/actions/workflows/lint_and_test.yml
    :alt: CI status of Linux/macOS/Windows

.. image:: https://coveralls.io/repos/github/thombashi/envinfopy/badge.svg?branch=master
    :target: https://coveralls.io/github/thombashi/envinfopy?branch=master
    :alt: Test coverage: coveralls

envinfopy is a Python Library to get execution environment information.


Installation
============================================
::

    python3 -m pip install envinfopy


Usage
============================================

Library usage
--------------------------------------------

Get execution environment information as a dictionary:

.. code-block:: python

    >>> import envinfopy
    >>> envinfopy.get_envinfo()
    {'uname': 'Linux', 'python_implementation': 'CPython', 'python_version': '3.11.4', 'platform': 'Ubuntu 22.04.2 LTS'}

Get execution environment information and specific package version information:

.. code-block:: python

    >>> import envinfopy
    >>> envinfopy.get_envinfo(["envinfopy"])
    {'uname': 'Linux', 'python_implementation': 'CPython', 'python_version': '3.11.4', 'platform': 'Ubuntu 22.04.2 LTS', 'envinfopy': '0.1.0'}

Get environment information as Markdown:

::

    python3 -m pip install envinfopy[markdown]  # install optional dependencies

.. code-block:: python

    >>> import envinfopy
    >>> print(envinfopy.dumps(["envinfopy"], format="markdown"))
    |  Module   |      Version       |
    | --------- | ------------------ |
    | uname     | Linux              |
    | Python    | CPython 3.11.4     |
    | platform  | Ubuntu 22.04.2 LTS |
    | envinfopy | 0.1.0              |

CLI usage
--------------------------------------------
::

    $ python3 -m install envinfopy[cli]  # install optional dependencies

    $ python3 -m envinfopy envinfopy setuptools --format markdown
    |   Module   |                 Version                 |
    | ---------- | --------------------------------------- |
    | uname      | Linux 5.15.90.1-microsoft-standard-WSL2 |
    | Python     | CPython 3.11.4                          |
    | platform   | Ubuntu 22.04.2 LTS                      |
    | envinfopy  | 0.0.7                                   |
    | setuptools | 67.8.0                                  |

Command help
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::

    usage: __main__.py [-h] [-V] [-v] [--format {text,markdown,md,json,itemize}] packages [packages ...]

    positional arguments:
      packages              PyPI package names to extract versions

    options:
      -h, --help            show this help message and exit
      -V, --version         show program's version number and exit
      -v, --verbose
      --format {text,markdown,md,json,itemize}
                            output format

    Issue tracker: https://github.com/thombashi/envinfopy/issues


Dependencies
============================================
Python 3.7+

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/thombashi/envinfopy",
    "name": "envinfopy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "environment,uname,version,markdown",
    "author": "Tsuyoshi Hombashi",
    "author_email": "tsuyoshi.hombashi@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/96/8d/2b11b36e391923a1a16a88a0921cab7bc4f1e43cbeb07c8819fe371b7dd2/envinfopy-0.2.0.tar.gz",
    "platform": null,
    "description": ".. contents:: **envinfopy**\n   :backlinks: top\n   :depth: 2\n\n\nSummary\n============================================\n.. image:: https://badge.fury.io/py/envinfopy.svg\n    :target: https://badge.fury.io/py/envinfopy\n    :alt: PyPI package version\n\n.. image:: https://img.shields.io/pypi/pyversions/envinfopy.svg\n    :target: https://pypi.org/project/envinfopy\n    :alt: Supported Python versions\n\n.. image:: https://img.shields.io/pypi/implementation/envinfopy.svg\n    :target: https://pypi.org/project/envinfopy\n    :alt: Supported Python implementations\n\n.. image:: https://github.com/thombashi/envinfopy/actions/workflows/lint_and_test.yml/badge.svg\n    :target: https://github.com/thombashi/envinfopy/actions/workflows/lint_and_test.yml\n    :alt: CI status of Linux/macOS/Windows\n\n.. image:: https://coveralls.io/repos/github/thombashi/envinfopy/badge.svg?branch=master\n    :target: https://coveralls.io/github/thombashi/envinfopy?branch=master\n    :alt: Test coverage: coveralls\n\nenvinfopy is a Python Library to get execution environment information.\n\n\nInstallation\n============================================\n::\n\n    python3 -m pip install envinfopy\n\n\nUsage\n============================================\n\nLibrary usage\n--------------------------------------------\n\nGet execution environment information as a dictionary:\n\n.. code-block:: python\n\n    >>> import envinfopy\n    >>> envinfopy.get_envinfo()\n    {'uname': 'Linux', 'python_implementation': 'CPython', 'python_version': '3.11.4', 'platform': 'Ubuntu 22.04.2 LTS'}\n\nGet execution environment information and specific package version information:\n\n.. code-block:: python\n\n    >>> import envinfopy\n    >>> envinfopy.get_envinfo([\"envinfopy\"])\n    {'uname': 'Linux', 'python_implementation': 'CPython', 'python_version': '3.11.4', 'platform': 'Ubuntu 22.04.2 LTS', 'envinfopy': '0.1.0'}\n\nGet environment information as Markdown:\n\n::\n\n    python3 -m pip install envinfopy[markdown]  # install optional dependencies\n\n.. code-block:: python\n\n    >>> import envinfopy\n    >>> print(envinfopy.dumps([\"envinfopy\"], format=\"markdown\"))\n    |  Module   |      Version       |\n    | --------- | ------------------ |\n    | uname     | Linux              |\n    | Python    | CPython 3.11.4     |\n    | platform  | Ubuntu 22.04.2 LTS |\n    | envinfopy | 0.1.0              |\n\nCLI usage\n--------------------------------------------\n::\n\n    $ python3 -m install envinfopy[cli]  # install optional dependencies\n\n    $ python3 -m envinfopy envinfopy setuptools --format markdown\n    |   Module   |                 Version                 |\n    | ---------- | --------------------------------------- |\n    | uname      | Linux 5.15.90.1-microsoft-standard-WSL2 |\n    | Python     | CPython 3.11.4                          |\n    | platform   | Ubuntu 22.04.2 LTS                      |\n    | envinfopy  | 0.0.7                                   |\n    | setuptools | 67.8.0                                  |\n\nCommand help\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n::\n\n    usage: __main__.py [-h] [-V] [-v] [--format {text,markdown,md,json,itemize}] packages [packages ...]\n\n    positional arguments:\n      packages              PyPI package names to extract versions\n\n    options:\n      -h, --help            show this help message and exit\n      -V, --version         show program's version number and exit\n      -v, --verbose\n      --format {text,markdown,md,json,itemize}\n                            output format\n\n    Issue tracker: https://github.com/thombashi/envinfopy/issues\n\n\nDependencies\n============================================\nPython 3.7+\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "envinfopy is a Python Library to get execution environment information.",
    "version": "0.2.0",
    "project_urls": {
        "Homepage": "https://github.com/thombashi/envinfopy",
        "Source": "https://github.com/thombashi/envinfopy",
        "Tracker": "https://github.com/thombashi/envinfopy/issues"
    },
    "split_keywords": [
        "environment",
        "uname",
        "version",
        "markdown"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "464a9bc95c866ec8bfe37196f334217f8f2b3f3cfbef008d8d9e67a27538daeb",
                "md5": "5b3ae4b6094044a2b143c96b486af3a0",
                "sha256": "fadd5a689da41221eca7a9b8031b92af7517f496ae6114f15e223c75cac0adac"
            },
            "downloads": -1,
            "filename": "envinfopy-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5b3ae4b6094044a2b143c96b486af3a0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 6900,
            "upload_time": "2023-07-16T15:33:50",
            "upload_time_iso_8601": "2023-07-16T15:33:50.866598Z",
            "url": "https://files.pythonhosted.org/packages/46/4a/9bc95c866ec8bfe37196f334217f8f2b3f3cfbef008d8d9e67a27538daeb/envinfopy-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "968d2b11b36e391923a1a16a88a0921cab7bc4f1e43cbeb07c8819fe371b7dd2",
                "md5": "04f5e5fd0b556b5edbe11b4be1ce6ed0",
                "sha256": "4b73ea5f1400cb3c3d9ed388d15cda2e8ee87d2ad6025ecceba8f54d27cfbf8c"
            },
            "downloads": -1,
            "filename": "envinfopy-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "04f5e5fd0b556b5edbe11b4be1ce6ed0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 8980,
            "upload_time": "2023-07-16T15:33:52",
            "upload_time_iso_8601": "2023-07-16T15:33:52.322207Z",
            "url": "https://files.pythonhosted.org/packages/96/8d/2b11b36e391923a1a16a88a0921cab7bc4f1e43cbeb07c8819fe371b7dd2/envinfopy-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-16 15:33:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "thombashi",
    "github_project": "envinfopy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "envinfopy"
}
        
Elapsed time: 0.14218s