Skip to main content

some platform related functions, which also work correctly on wine

Project description

lib_platform

Version v1.2.6 as of 2020-08-08 see Changelog

travis_build license jupyter pypi

codecov better_code Maintainability Maintainability Code Coverage snyk

some platform related functions, which also work correctly on wine


automated tests, Travis Matrix, Documentation, Badges, etc. are managed with 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.8-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64

100% code coverage, flake8 style checking ,mypy static type checking ,tested under Linux, macOS, Windows, automatic daily builds and monitoring



Try it Online

You might try it right away in Jupyter Notebook by using the “launch binder” badge, or click here

Usage

>>> 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

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:
python -m pip --upgrade pip
python -m pip --upgrade setuptools
  • to install the latest release from PyPi via pip (recommended):
python -m pip install --upgrade lib_platform
  • to install the latest version from github via pip:
python -m pip install --upgrade git+https://github.com/bitranox/lib_platform.git
  • include it into Your requirements.txt:
# 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:
# 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.
# 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 :

## 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

License

This software is licensed under the 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.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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lib-platform, version 1.2.6
Filename, size File type Python version Upload date Hashes
Filename, size lib_platform-1.2.6-py3.6.egg (11.8 kB) File type Egg Python version 3.6 Upload date Hashes View
Filename, size lib_platform-1.2.6-py3.7.egg (11.8 kB) File type Egg Python version 3.7 Upload date Hashes View
Filename, size lib_platform-1.2.6-py3.8.egg (11.8 kB) File type Egg Python version 3.8 Upload date Hashes View
Filename, size lib_platform-1.2.6-py3-none-any.whl (8.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size lib_platform-1.2.6.tar.gz (9.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page