Metadata-Version: 2.1
Name: lib-platform
Version: 1.2.7
Summary: some platform related functions, which also work correctly on wine
Home-page: https://github.com/bitranox/lib_platform
Author: Robert Nowotny
Author-email: bitranox@gmail.com
License: UNKNOWN
Description: lib_platform
        ============
        
        
        Version v1.2.7 as of 2020-10-09 see `Changelog`_
        
        |travis_build| |license| |jupyter| |pypi|
        
        |codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
        
        
        .. |travis_build| image:: https://img.shields.io/travis/bitranox/lib_platform/master.svg
           :target: https://travis-ci.org/bitranox/lib_platform
        
        .. |license| image:: https://img.shields.io/github/license/webcomics/pywine.svg
           :target: http://en.wikipedia.org/wiki/MIT_License
        
        .. |jupyter| image:: https://mybinder.org/badge_logo.svg
         :target: https://mybinder.org/v2/gh/bitranox/lib_platform/master?filepath=lib_platform.ipynb
        
        .. for the pypi status link note the dashes, not the underscore !
        .. |pypi| image:: https://img.shields.io/pypi/status/lib-platform?label=PyPI%20Package
           :target: https://badge.fury.io/py/lib_platform
        
        .. |codecov| image:: https://img.shields.io/codecov/c/github/bitranox/lib_platform
           :target: https://codecov.io/gh/bitranox/lib_platform
        
        .. |better_code| image:: https://bettercodehub.com/edge/badge/bitranox/lib_platform?branch=master
           :target: https://bettercodehub.com/results/bitranox/lib_platform
        
        .. |cc_maintain| image:: https://img.shields.io/codeclimate/maintainability-percentage/bitranox/lib_platform?label=CC%20maintainability
           :target: https://codeclimate.com/github/bitranox/lib_platform/maintainability
           :alt: Maintainability
        
        .. |cc_issues| image:: https://img.shields.io/codeclimate/issues/bitranox/lib_platform?label=CC%20issues
           :target: https://codeclimate.com/github/bitranox/lib_platform/maintainability
           :alt: Maintainability
        
        .. |cc_coverage| image:: https://img.shields.io/codeclimate/coverage/bitranox/lib_platform?label=CC%20coverage
           :target: https://codeclimate.com/github/bitranox/lib_platform/test_coverage
           :alt: Code Coverage
        
        .. |snyk| image:: https://img.shields.io/snyk/vulnerabilities/github/bitranox/lib_platform
           :target: https://snyk.io/test/github/bitranox/lib_platform
        
        .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
           :target: https://github.com/psf/black
        
        some platform related functions, which also work correctly on wine
        
        ----
        
        automated tests, Travis Matrix, Documentation, Badges, etc. are managed with `PizzaCutter <https://github
        .com/bitranox/PizzaCutter>`_ (cookiecutter on steroids)
        
        Python version required: 3.6.0 or newer
        
        tested on linux "bionic" with python 3.6, 3.7, 3.8, 3.9-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64
        
        `100% code coverage <https://codecov.io/gh/bitranox/lib_platform>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/lib_platform>`_, automatic daily builds and monitoring
        
        ----
        
        - `Try it Online`_
        - `Usage`_
        - `Usage from Commandline`_
        - `Installation and Upgrade`_
        - `Requirements`_
        - `Acknowledgements`_
        - `Contribute`_
        - `Report Issues <https://github.com/bitranox/lib_platform/blob/master/ISSUE_TEMPLATE.md>`_
        - `Pull Request <https://github.com/bitranox/lib_platform/blob/master/PULL_REQUEST_TEMPLATE.md>`_
        - `Code of Conduct <https://github.com/bitranox/lib_platform/blob/master/CODE_OF_CONDUCT.md>`_
        - `License`_
        - `Changelog`_
        
        ----
        
        Try it Online
        -------------
        
        You might try it right away in Jupyter Notebook by using the "launch binder" badge, or click `here <https://mybinder.org/v2/gh/{{rst_include.
        repository_slug}}/master?filepath=lib_platform.ipynb>`_
        
        Usage
        -----------
        
        .. code-block:: python
        
            >>> import lib_platform
        
            >>> # get system as string
            >>> system = lib_platform.system
        
            >>> # bool is_platform_linux
            >>> is_platform_linux = lib_platform.is_platform_linux
        
            >>> # bool is_platform_darwin
            >>> is_platform_darwin = lib_platform.is_platform_darwin
        
            >>> # bool is_platform_posix
            >>> # either darwin or linux
            >>> is_platform_posix = lib_platform.is_platform_posix
        
            >>> # bool is_platform_windows
            >>> # also True for windows_xp or windows_wine
            >>> is_platform_windows = lib_platform.is_platform_windows
        
            >>> # bool is_platform_windows_xp
            >>> is_platform_windows_xp = lib_platform.is_platform_windows_xp
        
            >>> # bool is_platform_windows_wine
            >>> is_platform_windows_wine = lib_platform.is_platform_windows_wine
        
            >>> # bool is_platform_windows_wine_xp
            >>> is_platform_windows_wine_xp = lib_platform.is_platform_windows_wine_xp
        
            >>> # string username lib_platform.username
            >>> username = lib_platform.username
        
            >>> # string fqdn hostname
            >>> hostname = lib_platform.hostname
        
            >>> # string hostname short
            >>> hostname_short = lib_platform.hostname_short
        
            >>> # path to userhome
            >>> path_userhome = lib_platform.path_userhome
        
            >>> # is user administrator (has user admin rights)
            >>> is_user_admin = lib_platform.is_user_admin
        
        Usage from Commandline
        ------------------------
        
        .. code-block:: bash
        
           Usage: lib_platform [OPTIONS] COMMAND [ARGS]...
        
             some platform related functions, which also work correctly on wine
        
           Options:
             --version                     Show the version and exit.
             --traceback / --no-traceback  return traceback information on cli
             -h, --help                    Show this message and exit.
        
           Commands:
             info  get program informations
        
        Installation and Upgrade
        ------------------------
        
        - Before You start, its highly recommended to update pip and setup tools:
        
        
        .. code-block:: bash
        
            python -m pip --upgrade pip
            python -m pip --upgrade setuptools
        
        - to install the latest release from PyPi via pip (recommended):
        
        .. code-block:: bash
        
            python -m pip install --upgrade lib_platform
        
        - to install the latest version from github via pip:
        
        
        .. code-block:: bash
        
            python -m pip install --upgrade git+https://github.com/bitranox/lib_platform.git
        
        
        - include it into Your requirements.txt:
        
        .. code-block:: bash
        
            # Insert following line in Your requirements.txt:
            # for the latest Release on pypi:
            lib_platform
        
            # for the latest development version :
            lib_platform @ git+https://github.com/bitranox/lib_platform.git
        
            # to install and upgrade all modules mentioned in requirements.txt:
            python -m pip install --upgrade -r /<path>/requirements.txt
        
        
        - to install the latest development version from source code:
        
        .. code-block:: bash
        
            # cd ~
            $ git clone https://github.com/bitranox/lib_platform.git
            $ cd lib_platform
            python setup.py install
        
        - via makefile:
          makefiles are a very convenient way to install. Here we can do much more,
          like installing virtual environments, clean caches and so on.
        
        .. code-block:: shell
        
            # from Your shell's homedirectory:
            $ git clone https://github.com/bitranox/lib_platform.git
            $ cd lib_platform
        
            # to run the tests:
            $ make test
        
            # to install the package
            $ make install
        
            # to clean the package
            $ make clean
        
            # uninstall the package
            $ make uninstall
        
        Requirements
        ------------
        following modules will be automatically installed :
        
        .. code-block:: bash
        
            ## Project Requirements
            click
            cli_exit_tools @ git+https://github.com/bitranox/cli_exit_tools.git
            lib_registry @ git+https://github.com/bitranox/lib_registry.git
        
        Acknowledgements
        ----------------
        
        - special thanks to "uncle bob" Robert C. Martin, especially for his books on "clean code" and "clean architecture"
        
        Contribute
        ----------
        
        I would love for you to fork and send me pull request for this project.
        - `please Contribute <https://github.com/bitranox/lib_platform/blob/master/CONTRIBUTING.md>`_
        
        License
        -------
        
        This software is licensed under the `MIT license <http://en.wikipedia.org/wiki/MIT_License>`_
        
        ---
        
        Changelog
        =========
        
        - new MAJOR version for incompatible API changes,
        - new MINOR version for added functionality in a backwards compatible manner
        - new PATCH version for backwards compatible bug fixes
        
        v1.2.7
        --------
        2020-10-09: service release
            - update travis build matrix for linux 3.9-dev
            - update travis build matrix (paths) for windows 3.9 / 3.10
        
        v1.2.6
        --------
        2020-08-08: service release
            - fix documentation
            - fix travis
            - deprecate pycodestyle
            - implement flake8
        
        v1.2.5
        ---------
        2020-08-01: fix pypi deploy
        
        v1.2.4
        --------
        2020-07-31: fix travis build
        
        v1.2.3
        --------
        2020-07-29: feature release
            - use the new pizzacutter template
            - use cli_exit_tools
        
        v1.2.2
        --------
        2020-07-16: feature release
            - fix cli test
            - enable traceback option on cli errors
        
        v1.2.1
        --------
        2020-07-14 : patch release
            - make it compatible with latest lib_registry
        
        
        v1.2.0
        --------
        2020-07-07 : service release
            - new click cli
            - use PizzaCutter Template
            - added jupyter notebook
            - dropped python2.7 - python3.5 support
        
        v1.0.3
        --------
        2019-06-14: add is_user_admin (check for administration rights)
        
        v1.0.2
        --------
        2019-04-28: Documentation Update, minor Fixes in setup.py
        
        v1.0.0
        --------
        2019-03-28: Initial public release, PyPi Release
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6.0
Description-Content-Type: text/x-rst
