Metadata-Version: 2.1
Name: platform-utils
Version: 0.41
Summary: Cross-platform utilities for accomplishing some tasks that the stdlib isn't equipped to provide
Home-page: UNKNOWN
Author: Christopher Toth
Author-email: q@q-continuum.net
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: pywin32 ; sys_platform == "win32"
Requires-Dist: winpaths ; sys_platform == "win32"

====================
Platform_utils
====================

Platform_utils is a library which provides several cross-platform utilities, including:

* path manipulation - allows you to do several things with paths including getting the path to store application data, creating the application data directory, checking whether the app is frozen, etc.
* clipboard - allows getting/setting clipboard text.
* idle - allows getting the user idle time on Windows.
* process - allows killing processes on Windows and Unix.
* shell_integration - adds something to the context menu on Windows.
* blackhole - disables stdout/stderr when using py2exe.

Examples
==========

Check whether the app is frozen:
----------------------------------------


.. code-block:: python

    >>> import platform_utils.paths
    >>> platform_utils.paths.is_frozen()
    False

Find the recommended directory where user data files should be stored:
--------------------------------------------------------------------------------

.. code-block:: python

    >>> import platform_utils.paths
    >>> platform_utils.paths.app_data_path("app name")
    u'C:\\Users\\user\\AppData\\Roaming\\app name'


