Metadata-Version: 2.0
Name: jaraco.windows
Version: 3.6.2
Summary: Windows Routines by Jason R. Coombs
Home-page: https://github.com/jaraco/jaraco.windows
Author: Jason R. Coombs
Author-email: jaraco@jaraco.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
Requires-Dist: jaraco.collections
Requires-Dist: jaraco.structures (>=1.1.1)
Requires-Dist: jaraco.text
Requires-Dist: jaraco.ui
Requires-Dist: more-itertools
Requires-Dist: path.py
Requires-Dist: six

jaraco.windows
==============

.. contents::

Status and License
------------------

``jaraco.windows`` aims to provide a pure-python interface to Windows
APIs using ctypes. This package is not designed to be exhaustive, but
rather to supply interfaces as they are needed by the contributors.

``jaraco.windows`` is written by Jason R. Coombs.  It is licensed under an
`MIT-style permissive license
<http://www.opensource.org/licenses/mit-license.php>`_.

Package Contents
----------------

``jaraco.windows`` contains several modules for different purposes. For now,
read the source. Eventually, I hope to put high-level descriptions of the modules
here.

Installation
------------

You should install this module the normal way using pip or easy_install.

If you want to monkeypatch the os module to include symlink compatibility, you
should add the following to your ``usercustomize`` or ``sitecustomize`` module:

	``import jaraco.windows.filesystem as fs; fs.patch_os_module()``

Thereafter, you should be able to use ``os.symlink`` and ``os.readlink`` in Windows
Vista and later using the same interface as on Unix.

Note that ``jaraco.windows.filesystem.symlink`` takes an additional optional
parameter ``target_is_directory``, which must be specified if the target is not
present and is expected to be a directory once present.

Contribute
----------

If jaraco.windows doesn't supply the interface you require for your
application, consider creating the interface and providing a patch
to the author.


