Metadata-Version: 2.4
Name: OSDetect
Version: 1.2.1
Summary: A simple helper module to get details on the current operating system platorm.
Project-URL: Homepage, https://malte70.github.io/OSDetect/
Project-URL: Repository, https://github.com/malte70/OSDetect
Project-URL: Issues, https://github.com/malte70/OSDetect/issues
Author: Malte Bublitz
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown

OSDetect [![Build Status](https://travis-ci.org/malte70/OSDetect.svg?branch=master)](https://travis-ci.org/malte70/OSDetect)
========

What is OSDetect?
-----------------

OSDetect is a small python module which is able to get some information
about your system and python implementation, like the Operating System
or the hardware platform.

Supported operating systems
---------------------------

As of now, only GNU/Linux, Mac OS X, Windows NT and Windows NT/Cygwin are supported. At the
moment, I'm working on support for a wider range of operating systems.

Since version 1.1.0, Python 2 and Python 3 are both supported.

Note that the information available on the different platforms may differ.

Installation instructions
-------------------------

You can install OSDetect from PyPI using pip:

```
pip install OSDetect
```

Alternatively clone this repository and install directly from the source code:

```
git clone https://github.com/malte70/OSDetect
cd OSDetect
pip install .
```

Command Line Usage
------------------

OSDetect includes a function which is executed if the module is directly called. So give it
a try and run:

	python -m OSDetect

Example uses of the module
--------------------------

```python
# Get a dict containing all gathered information
from OSDetect import info as os_info
print(os_info.getInfo())

# Get a specific value
print(os_info.getDistribution())
# or using the dict key (a dot means a dict containing a dict)
print(os_info.get("Python.Version"))
```

On a ArchLinux system, it looks like this:

```python
{
	'Python': {
		'Version': '3.6.0',
		'Implementation': 'CPython'
	},
	'Machine': 'i686',
	'OS': 'Linux',
	'OSVersion': '4.10.6-1-ARCH',
	'Distribution': 'Arch Linux'
}

'ArchLinux'
'3.6.0'
```

