Metadata-Version: 2.4
Name: krozark-current-platform
Version: 0.2.0
Summary: The aim of this project is to get the current running platform
Home-page: https://github.com/Krozark/platform
Author: Maxime Barbier
Author-email: maxime.barbier1991+platform@gmail.com
License: BSD2
Keywords: current platform
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# platform
simple python function to get the current running platform

## Usage

```python
import currentplatform as cp

cp.platform            # the current OS, or 'unknown' if not supported

cp.desktop_platforms   # ('win', 'macosx', 'linux')
cp.mobile_platforms    # ('android', 'ios')
cp.platforms           # every supported OS (desktop + mobile)

cp.is_supported()      # False when running on an unsupported OS

# test whether we run on a desktop or a smartphone
if cp.platform in cp.desktop_platforms:
    print("running on a desktop")
elif cp.platform in cp.mobile_platforms:
    print("running on a smartphone")
else:
    print("unsupported platform")
```
