Metadata-Version: 2.0
Name: jaraco.windows
Version: 3.8
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
Description-Content-Type: 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-Python: >=2.7
Requires-Dist: more-itertools
Requires-Dist: six
Requires-Dist: jaraco.ui
Requires-Dist: jaraco.collections
Requires-Dist: jaraco.text
Requires-Dist: jaraco.structures (>=1.1.1)
Requires-Dist: path.py (>=6.2)
Provides-Extra: docs
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: jaraco.packaging (>=3.2); extra == 'docs'
Requires-Dist: rst.linker (>=1.9); extra == 'docs'
Provides-Extra: testing
Requires-Dist: pytest (>=2.8); extra == 'testing'
Requires-Dist: pytest-sugar; extra == 'testing'
Requires-Dist: collective.checkdocs; extra == 'testing'

.. image:: https://img.shields.io/pypi/v/jaraco.windows.svg
   :target: https://pypi.org/project/jaraco.windows

.. image:: https://img.shields.io/pypi/pyversions/jaraco.windows.svg

.. image:: https://img.shields.io/travis/jaraco/jaraco.windows/master.svg
   :target: http://travis-ci.org/jaraco/jaraco.windows

.. image:: https://ci.appveyor.com/api/projects/status/f5l6sv7ox8q1ypo6?svg=true
   :target: https://ci.appveyor.com/project/jaraco/jaraco-windows

.. image:: https://readthedocs.org/projects/jaracowindows/badge/?version=latest
   :target: http://jaracowindows.readthedocs.io/en/latest/?badge=latest


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.

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 pull request
to the project.


