geopmpy


Namegeopmpy JSON
Version 3.1.0 PyPI version JSON
download
home_pageNone
SummaryGEOPM - Global Extensible Open Power Manager Runtime Tools
upload_time2024-05-29 18:49:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseCopyright (c) 2015 - 2024 Intel Corporation Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords runtime hardware telemetry configuration
VCS
bugtrack_url
requirements setuptools_scm build
Travis-CI No Travis.
coveralls test coverage No coveralls.
            geopmpy
========
This directory contains source code for the `geopmpy` Python package, which
provides python bindings for `libgeopm`, as well as the `geopmlaunch` tool.

Subdirectories include:

* [debian](debian): Configuration files for debian packaging scripts
* [geopmpy](geopmpy): Source code for modules in this package
* [test](test): Test code for this package

Set Up a Development Environment
--------------------------------
Run `pip install -e .` to install this directory in editable mode (so you don't need to reinstall between updating python source code and re-running tests). That will also install the python execution-time dependencies of this package. Also run `pip install -f requirements.txt` to install additional development dependencies. If you follow these steps, then you do not need to modify your `PYTHONPATH` variable when executing tests.

The `geopmpy` package depends on `geopmdpy`, so also be sure to install that package (e.g., in editable mode as done for this package).

The `geopmpy` package wraps `libgeopm`, which also depends on `libgeopmd`. Be sure to follow the build instructions in the directories for those libraries as part of setting up a geopmpy development environment. Either install those builds somewhere on your path, or manually add them to your `LD_LIBRARY_PATH` (examples in the next section).

Executing Tests
---------------
Run `LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs" python3 test` from this directory to launch the entire test suite. Some of the tests depend on `libgeopm`, so it should be built before running tests.
Alternatively, run `LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs" python3 -m unittest discover -p 'Test*.py'`

Execute a single test case with `LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs" python -m unittest <one.or.more.test.modules.or.classes.or.functions>`. For example:
`LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs" python -m unittest test.TestAgent.TestAgent.test_policy_names`

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "geopmpy",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "Christopher Cantalupo <christopher.m.cantalupo@intel.com>, Brad Geltz <brad.geltz@intel.com>",
    "keywords": "runtime, hardware, telemetry, configuration",
    "author": null,
    "author_email": "Christopher Cantalupo <christopher.m.cantalupo@intel.com>, Brad Geltz <brad.geltz@intel.com>",
    "download_url": "https://files.pythonhosted.org/packages/37/53/564fce267cb337b6f475f22226a5bb5cd9156948007fd64707fa393f5b82/geopmpy-3.1.0.tar.gz",
    "platform": null,
    "description": "geopmpy\n========\nThis directory contains source code for the `geopmpy` Python package, which\nprovides python bindings for `libgeopm`, as well as the `geopmlaunch` tool.\n\nSubdirectories include:\n\n* [debian](debian): Configuration files for debian packaging scripts\n* [geopmpy](geopmpy): Source code for modules in this package\n* [test](test): Test code for this package\n\nSet Up a Development Environment\n--------------------------------\nRun `pip install -e .` to install this directory in editable mode (so you don't need to reinstall between updating python source code and re-running tests). That will also install the python execution-time dependencies of this package. Also run `pip install -f requirements.txt` to install additional development dependencies. If you follow these steps, then you do not need to modify your `PYTHONPATH` variable when executing tests.\n\nThe `geopmpy` package depends on `geopmdpy`, so also be sure to install that package (e.g., in editable mode as done for this package).\n\nThe `geopmpy` package wraps `libgeopm`, which also depends on `libgeopmd`. Be sure to follow the build instructions in the directories for those libraries as part of setting up a geopmpy development environment. Either install those builds somewhere on your path, or manually add them to your `LD_LIBRARY_PATH` (examples in the next section).\n\nExecuting Tests\n---------------\nRun `LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs\" python3 test` from this directory to launch the entire test suite. Some of the tests depend on `libgeopm`, so it should be built before running tests.\nAlternatively, run `LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs\" python3 -m unittest discover -p 'Test*.py'`\n\nExecute a single test case with `LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs\" python -m unittest <one.or.more.test.modules.or.classes.or.functions>`. For example:\n`LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH:$PWD/../libgeopm/.libs\" python -m unittest test.TestAgent.TestAgent.test_policy_names`\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2015 - 2024 Intel Corporation  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "GEOPM - Global Extensible Open Power Manager Runtime Tools",
    "version": "3.1.0",
    "project_urls": {
        "Documentation": "https://geopm.github.io/geopmpy.7.html",
        "Homepage": "https://geopm.github.io",
        "Source": "https://github.com/geopm/geopm/"
    },
    "split_keywords": [
        "runtime",
        " hardware",
        " telemetry",
        " configuration"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1ddcc4376dc0dc044454f7d41e92b4a73c432eb4a6f8866d55cc86bfcd5a81c6",
                "md5": "8ad913a3a04fe10b987a50af19b2d41e",
                "sha256": "edfbfcb1a6edf2dc08a298b6d6741a987529d9e58aab2f520c215e773226296e"
            },
            "downloads": -1,
            "filename": "geopmpy-3.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8ad913a3a04fe10b987a50af19b2d41e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 39180,
            "upload_time": "2024-05-29T18:49:38",
            "upload_time_iso_8601": "2024-05-29T18:49:38.691402Z",
            "url": "https://files.pythonhosted.org/packages/1d/dc/c4376dc0dc044454f7d41e92b4a73c432eb4a6f8866d55cc86bfcd5a81c6/geopmpy-3.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3753564fce267cb337b6f475f22226a5bb5cd9156948007fd64707fa393f5b82",
                "md5": "6bece9f02dcfac3d0bf3047ab2fcad0c",
                "sha256": "a807c733d27e29831ee1ed5bf21b80f8ff7d43f4c793360a0b4e1586148484be"
            },
            "downloads": -1,
            "filename": "geopmpy-3.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6bece9f02dcfac3d0bf3047ab2fcad0c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 62700,
            "upload_time": "2024-05-29T18:49:39",
            "upload_time_iso_8601": "2024-05-29T18:49:39.965781Z",
            "url": "https://files.pythonhosted.org/packages/37/53/564fce267cb337b6f475f22226a5bb5cd9156948007fd64707fa393f5b82/geopmpy-3.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-29 18:49:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "geopm",
    "github_project": "geopm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "setuptools_scm",
            "specs": [
                [
                    ">=",
                    "6.4.2"
                ]
            ]
        },
        {
            "name": "build",
            "specs": [
                [
                    ">=",
                    "0.9.0"
                ]
            ]
        }
    ],
    "lcname": "geopmpy"
}
        
Elapsed time: 0.71658s