.. 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://github.com/jaraco/jaraco.windows/workflows/tests/badge.svg
:target: https://github.com/jaraco/jaraco.windows/actions?query=workflow%3A%22tests%22
:alt: tests
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Ruff
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code style: Black
.. image:: https://readthedocs.org/projects/jaracowindows/badge/?version=latest
:target: https://jaracowindows.readthedocs.io/en/latest/?badge=latest
.. image:: https://img.shields.io/badge/skeleton-2023-informational
:target: https://blog.jaraco.com/skeleton
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.
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/jaraco/jaraco.windows",
"name": "jaraco.windows",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Jason R. Coombs",
"author_email": "jaraco@jaraco.com",
"download_url": "https://files.pythonhosted.org/packages/11/19/c04c76a8453fcc04a9d8a2187d0b13550341f01d365ba2a057a30e01340f/jaraco.windows-5.8.0.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/jaraco.windows.svg\n :target: https://pypi.org/project/jaraco.windows\n\n.. image:: https://img.shields.io/pypi/pyversions/jaraco.windows.svg\n\n.. image:: https://github.com/jaraco/jaraco.windows/workflows/tests/badge.svg\n :target: https://github.com/jaraco/jaraco.windows/actions?query=workflow%3A%22tests%22\n :alt: tests\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Ruff\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code style: Black\n\n.. image:: https://readthedocs.org/projects/jaracowindows/badge/?version=latest\n :target: https://jaracowindows.readthedocs.io/en/latest/?badge=latest\n\n.. image:: https://img.shields.io/badge/skeleton-2023-informational\n :target: https://blog.jaraco.com/skeleton\n\n\nA pure-python interface to Windows\nAPIs using ctypes. This package is not designed to be exhaustive, but\nrather to supply interfaces as they are needed by the contributors.\n\nPackage Contents\n================\n\n``jaraco.windows`` contains several modules for different purposes. For now,\nread the source. Eventually, I hope to put high-level descriptions of the modules\nhere.\n\nInstallation\n============\n\nYou should install this module the normal way using pip.\n\nIf you want to monkeypatch the os module to include symlink compatibility, you\nshould add the following to your ``usercustomize`` or ``sitecustomize`` module:\n\n\t``import jaraco.windows.filesystem as fs; fs.patch_os_module()``\n\nThereafter, you should be able to use ``os.symlink`` and ``os.readlink`` in Windows\nVista and later using the same interface as on Unix.\n\nNote that ``jaraco.windows.filesystem.symlink`` takes an additional optional\nparameter ``target_is_directory``, which must be specified if the target is not\npresent and is expected to be a directory once present.\n\nContribute\n==========\n\nIf jaraco.windows doesn't supply the interface you require for your\napplication, consider creating the interface and providing a pull request\nto the project.\n",
"bugtrack_url": null,
"license": "",
"summary": "Windows Routines by Jason R. Coombs",
"version": "5.8.0",
"project_urls": {
"Homepage": "https://github.com/jaraco/jaraco.windows"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "058b03877b7561cfa0f09ddd948a159f63739829f01bdd39a918aa0754f38570",
"md5": "6e6fb2fcfee9acff0710315e0c8c09b0",
"sha256": "2fa49ef411c14fd2e59b6879ec68b225608ec125eb121c882847131c027d0ddc"
},
"downloads": -1,
"filename": "jaraco.windows-5.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e6fb2fcfee9acff0710315e0c8c09b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 59661,
"upload_time": "2023-11-27T18:56:13",
"upload_time_iso_8601": "2023-11-27T18:56:13.367761Z",
"url": "https://files.pythonhosted.org/packages/05/8b/03877b7561cfa0f09ddd948a159f63739829f01bdd39a918aa0754f38570/jaraco.windows-5.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1119c04c76a8453fcc04a9d8a2187d0b13550341f01d365ba2a057a30e01340f",
"md5": "f8f3ed796f45aa61f69254c4a40473ad",
"sha256": "9215675639e80f96190203b66c37f56479ee68e20841aa4bca309208dd2d8e10"
},
"downloads": -1,
"filename": "jaraco.windows-5.8.0.tar.gz",
"has_sig": false,
"md5_digest": "f8f3ed796f45aa61f69254c4a40473ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 55518,
"upload_time": "2023-11-27T18:56:15",
"upload_time_iso_8601": "2023-11-27T18:56:15.497732Z",
"url": "https://files.pythonhosted.org/packages/11/19/c04c76a8453fcc04a9d8a2187d0b13550341f01d365ba2a057a30e01340f/jaraco.windows-5.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 18:56:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jaraco",
"github_project": "jaraco.windows",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "jaraco.windows"
}
JSON
