===============================
WinFSPy
===============================
.. image:: https://github.com/scille/winfspy/actions/workflows/ci.yml/badge.svg
:target: https://github.com/scille/winfspy/actions/workflows/ci.yml
:alt: GitHub Actions Status
.. image:: https://codecov.io/gh/Scille/winfspy/branch/master/graph/badge.svg
:target: https://codecov.io/gh/Scille/winfspy
.. image:: https://img.shields.io/pypi/v/winfspy.svg
:target: https://pypi.python.org/pypi/winfspy
:alt: Pypi Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Code style: black
Bindings for `WinFSP <http://www.secfs.net/winfsp/>`_ version 1.4 and onward.
Winfspy consists of three important modules:
- ``winfspy``: expose the WinFSP API
- ``winfspy.memfs``: a memory file system based on winfspy
- ``winfspy.tests.winfsp_tests``: a test suite for black box testing
- ``winfspy.tests.winfstest``: a lighter test suite for black box testing
Requirements and installation
-----------------------------
`WinFSP <http://www.secfs.net/winfsp/>`_ version 1.4 or higher has to be installed separately.
Then install winfspy using pip::
$ pip install winfspy
WinFSP python API
-----------------
Usage::
from winfspy import (
FileSystem,
BaseFileSystemOperations,
enable_debug_log,
FILE_ATTRIBUTE,
CREATE_FILE_CREATE_OPTIONS,
NTStatusObjectNameNotFound,
NTStatusDirectoryNotEmpty,
NTStatusNotADirectory,
NTStatusObjectNameCollision,
NTStatusAccessDenied,
NTStatusEndOfFile,
)
Winfspy memory file system
---------------------------
Usage::
# Run the memory fs as X: drive in verbose mode
$ python -m winfspy.memfs X: -v
# More information
$ python -m winfspy.memfs
Winfsp-tests test suite
-----------------------
This test suite integrates the external test suite of
`winfsp-tests <https://github.com/billziss-gh/winfsp/tree/master/tst/winfsp-tests>`_.
Usage::
# Install winfspy with the test dependencies
$ pip install winfspy[test]
# Run the winfstest test suite on an existing X: drive
$ python winfspy.tests.winfsp_tests --file-system-path X:
# More information about pytest
$ python winfspy.tests.winfsp_tests -h
Winfstest test suite
--------------------
This test suite is taken from
`secfs.test.winfstest <https://bitbucket.org/billziss/secfs.test/>`_.
It is basic yet useful to test common use cases.
Usage::
# Install winfspy with the test dependencies
$ pip install winfspy[test]
# Run the winfstest test suite on an existing X: drive
$ python winfspy.tests.winfstest --file-system-path X:
# More information about pytest
$ python winfspy.tests.winfstest -h
License
-------
Free software: BSD
Raw data
{
"_id": null,
"home_page": "https://github.com/Scille/winfspy",
"name": "winfspy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Emmanuel Leblond",
"author_email": "emmanuel.leblond@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/95/02/a8046c785442e232121ff526d50057e27158c1f1e09f8a29d51960cad393/winfspy-0.8.4.tar.gz",
"platform": null,
"description": "===============================\r\nWinFSPy\r\n===============================\r\n\r\n.. image:: https://github.com/scille/winfspy/actions/workflows/ci.yml/badge.svg\r\n :target: https://github.com/scille/winfspy/actions/workflows/ci.yml\r\n :alt: GitHub Actions Status\r\n\r\n.. image:: https://codecov.io/gh/Scille/winfspy/branch/master/graph/badge.svg\r\n :target: https://codecov.io/gh/Scille/winfspy\r\n\r\n.. image:: https://img.shields.io/pypi/v/winfspy.svg\r\n :target: https://pypi.python.org/pypi/winfspy\r\n :alt: Pypi Status\r\n\r\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\r\n :target: https://github.com/ambv/black\r\n :alt: Code style: black\r\n\r\nBindings for `WinFSP <http://www.secfs.net/winfsp/>`_ version 1.4 and onward.\r\n\r\nWinfspy consists of three important modules:\r\n\r\n- ``winfspy``: expose the WinFSP API\r\n- ``winfspy.memfs``: a memory file system based on winfspy\r\n- ``winfspy.tests.winfsp_tests``: a test suite for black box testing\r\n- ``winfspy.tests.winfstest``: a lighter test suite for black box testing\r\n\r\n\r\nRequirements and installation\r\n-----------------------------\r\n\r\n`WinFSP <http://www.secfs.net/winfsp/>`_ version 1.4 or higher has to be installed separately.\r\n\r\nThen install winfspy using pip::\r\n\r\n $ pip install winfspy\r\n\r\n\r\nWinFSP python API\r\n-----------------\r\n\r\nUsage::\r\n\r\n from winfspy import (\r\n FileSystem,\r\n BaseFileSystemOperations,\r\n enable_debug_log,\r\n FILE_ATTRIBUTE,\r\n CREATE_FILE_CREATE_OPTIONS,\r\n NTStatusObjectNameNotFound,\r\n NTStatusDirectoryNotEmpty,\r\n NTStatusNotADirectory,\r\n NTStatusObjectNameCollision,\r\n NTStatusAccessDenied,\r\n NTStatusEndOfFile,\r\n )\r\n\r\n\r\nWinfspy memory file system\r\n---------------------------\r\n\r\nUsage::\r\n\r\n # Run the memory fs as X: drive in verbose mode\r\n $ python -m winfspy.memfs X: -v\r\n\r\n # More information\r\n $ python -m winfspy.memfs\r\n\r\n\r\nWinfsp-tests test suite\r\n-----------------------\r\n\r\nThis test suite integrates the external test suite of\r\n`winfsp-tests <https://github.com/billziss-gh/winfsp/tree/master/tst/winfsp-tests>`_.\r\n\r\nUsage::\r\n\r\n # Install winfspy with the test dependencies\r\n $ pip install winfspy[test]\r\n\r\n # Run the winfstest test suite on an existing X: drive\r\n $ python winfspy.tests.winfsp_tests --file-system-path X:\r\n\r\n # More information about pytest\r\n $ python winfspy.tests.winfsp_tests -h\r\n\r\n\r\nWinfstest test suite\r\n--------------------\r\n\r\nThis test suite is taken from\r\n`secfs.test.winfstest <https://bitbucket.org/billziss/secfs.test/>`_.\r\nIt is basic yet useful to test common use cases.\r\n\r\nUsage::\r\n\r\n # Install winfspy with the test dependencies\r\n $ pip install winfspy[test]\r\n\r\n # Run the winfstest test suite on an existing X: drive\r\n $ python winfspy.tests.winfstest --file-system-path X:\r\n\r\n # More information about pytest\r\n $ python winfspy.tests.winfstest -h\r\n\r\n\r\nLicense\r\n-------\r\n\r\nFree software: BSD\r\n",
"bugtrack_url": null,
"license": "",
"summary": "CFFI bindings for WinFSP",
"version": "0.8.4",
"project_urls": {
"Homepage": "https://github.com/Scille/winfspy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4890e2ab30b1489688100afcc7b670ab55af6527fa7f4b09881d539bf69397f",
"md5": "13206ce8630e12be034cfe0a91be6caa",
"sha256": "6cd3905e1c1c768d229a9aba9ac6f5283bc5586cb0696ead45e8cdd608beba0e"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp310-cp310-win32.whl",
"has_sig": false,
"md5_digest": "13206ce8630e12be034cfe0a91be6caa",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 86456,
"upload_time": "2023-06-05T08:50:21",
"upload_time_iso_8601": "2023-06-05T08:50:21.117550Z",
"url": "https://files.pythonhosted.org/packages/c4/89/0e2ab30b1489688100afcc7b670ab55af6527fa7f4b09881d539bf69397f/winfspy-0.8.4-cp310-cp310-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e97b22495ae83a119528ac93d804ccf0e55166a0e4a694c029d2d4096c6b776a",
"md5": "74d065dce3a64a95f3f6ef6b76eb9017",
"sha256": "7acd765fc0c22e6b09bd7f4be3fc562651ec555dfffed13ec42d1db1333f0373"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "74d065dce3a64a95f3f6ef6b76eb9017",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 95141,
"upload_time": "2023-06-05T08:50:24",
"upload_time_iso_8601": "2023-06-05T08:50:24.002448Z",
"url": "https://files.pythonhosted.org/packages/e9/7b/22495ae83a119528ac93d804ccf0e55166a0e4a694c029d2d4096c6b776a/winfspy-0.8.4-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7971272a8f8a1ae1fc70ecc15b14c5dce0afb17db262fab347f224a78608819",
"md5": "154757c1cd8ddf2ead48993a5dba9d65",
"sha256": "ddacd50871dc104bd769a27d9491bafa8cd8a5998bdcbad39704361744b3a8bf"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp311-cp311-win32.whl",
"has_sig": false,
"md5_digest": "154757c1cd8ddf2ead48993a5dba9d65",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 86456,
"upload_time": "2023-06-05T08:50:25",
"upload_time_iso_8601": "2023-06-05T08:50:25.664296Z",
"url": "https://files.pythonhosted.org/packages/d7/97/1272a8f8a1ae1fc70ecc15b14c5dce0afb17db262fab347f224a78608819/winfspy-0.8.4-cp311-cp311-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8de5005c7872c22feafb2372aca023f30669beade46a1fe396759b7cc5266e0",
"md5": "8d28a07d5badcb07cb0cde2e0cf8755e",
"sha256": "518581972a2f07806702250cb47c25c0722b37ebd2402d5b06e07fecea253317"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "8d28a07d5badcb07cb0cde2e0cf8755e",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 95142,
"upload_time": "2023-06-05T08:50:27",
"upload_time_iso_8601": "2023-06-05T08:50:27.055312Z",
"url": "https://files.pythonhosted.org/packages/e8/de/5005c7872c22feafb2372aca023f30669beade46a1fe396759b7cc5266e0/winfspy-0.8.4-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7a4b5f8cc15cad6f46a869b5483f36391d95ff52eb478b68f6b8f310553b857",
"md5": "a47373de7a4741b8a42cd34c7d559fdb",
"sha256": "6e92aedb32b8948e3a741ffcc273f36d245b3c22b6959263a420ec8ba3402bc9"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp36-cp36m-win32.whl",
"has_sig": false,
"md5_digest": "a47373de7a4741b8a42cd34c7d559fdb",
"packagetype": "bdist_wheel",
"python_version": "cp36",
"requires_python": null,
"size": 87021,
"upload_time": "2023-06-05T08:50:28",
"upload_time_iso_8601": "2023-06-05T08:50:28.799282Z",
"url": "https://files.pythonhosted.org/packages/a7/a4/b5f8cc15cad6f46a869b5483f36391d95ff52eb478b68f6b8f310553b857/winfspy-0.8.4-cp36-cp36m-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18a16be166c575a0f0652ddf5259424710ac53a5e869202463de6043aa927baa",
"md5": "1baf81cf98affa1664fdde3f32fd100e",
"sha256": "7398c3e105c88b411018e8e6b6b51182e28051541d98eee66fa3db20c7252c43"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp36-cp36m-win_amd64.whl",
"has_sig": false,
"md5_digest": "1baf81cf98affa1664fdde3f32fd100e",
"packagetype": "bdist_wheel",
"python_version": "cp36",
"requires_python": null,
"size": 96400,
"upload_time": "2023-06-05T08:50:30",
"upload_time_iso_8601": "2023-06-05T08:50:30.301213Z",
"url": "https://files.pythonhosted.org/packages/18/a1/6be166c575a0f0652ddf5259424710ac53a5e869202463de6043aa927baa/winfspy-0.8.4-cp36-cp36m-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "593ac812a1e49aa570484d97b0c6adc047ad1b2d2681dba3d099f76caa4ee1a6",
"md5": "d283a4597c5f8bedd8ff830b63ea6166",
"sha256": "78593231511ef81e9ac8f6c57a67fd574b41d799234665b928b3a162e13be942"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp37-cp37m-win32.whl",
"has_sig": false,
"md5_digest": "d283a4597c5f8bedd8ff830b63ea6166",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": null,
"size": 86515,
"upload_time": "2023-06-05T08:50:31",
"upload_time_iso_8601": "2023-06-05T08:50:31.958252Z",
"url": "https://files.pythonhosted.org/packages/59/3a/c812a1e49aa570484d97b0c6adc047ad1b2d2681dba3d099f76caa4ee1a6/winfspy-0.8.4-cp37-cp37m-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4249ed3b6ba4fbddad3c86fe8c7ebb7ca2a8e47e089901099dae0caa64709382",
"md5": "1fec79529a04f68b60e7a3b1058d40be",
"sha256": "c4e8e426bab320f1b3ae9974cf5f7825018b994f6740fbdd32c29f021de4586d"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp37-cp37m-win_amd64.whl",
"has_sig": false,
"md5_digest": "1fec79529a04f68b60e7a3b1058d40be",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": null,
"size": 95144,
"upload_time": "2023-06-05T08:50:33",
"upload_time_iso_8601": "2023-06-05T08:50:33.168354Z",
"url": "https://files.pythonhosted.org/packages/42/49/ed3b6ba4fbddad3c86fe8c7ebb7ca2a8e47e089901099dae0caa64709382/winfspy-0.8.4-cp37-cp37m-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a85e7c8f9aca4b02fc68951d639e65ee48ea73e17089a4f5caa6f1494fc39a2d",
"md5": "1d2c0dd570c06b9f74f2834203fc2c26",
"sha256": "7f07fd22616adfeb81fb82a8bc390f62202b0a8d112620754223556603805225"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp38-cp38-win32.whl",
"has_sig": false,
"md5_digest": "1d2c0dd570c06b9f74f2834203fc2c26",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 86457,
"upload_time": "2023-06-05T08:50:35",
"upload_time_iso_8601": "2023-06-05T08:50:35.046989Z",
"url": "https://files.pythonhosted.org/packages/a8/5e/7c8f9aca4b02fc68951d639e65ee48ea73e17089a4f5caa6f1494fc39a2d/winfspy-0.8.4-cp38-cp38-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "688ade0bc0f7ef4c09379e84558896b55b9cd52156d17a02154b731a10a339b8",
"md5": "0d201b0fd80a4b3adecdcc9455f8e7de",
"sha256": "6af41b0083810d6a5b87f1e9cdc8b6c6204f3c8d4406686129437870bfdade17"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "0d201b0fd80a4b3adecdcc9455f8e7de",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 95137,
"upload_time": "2023-06-05T08:50:36",
"upload_time_iso_8601": "2023-06-05T08:50:36.455583Z",
"url": "https://files.pythonhosted.org/packages/68/8a/de0bc0f7ef4c09379e84558896b55b9cd52156d17a02154b731a10a339b8/winfspy-0.8.4-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "097a1de77345674e167f63c64deffc83e0dba94f00ee28cbac1aaa4f0052b662",
"md5": "06c9e70ff03e5c945095b485fb0ed9c0",
"sha256": "4b4eb4a31fe983a137f498819dd9b7bcbf456adfc0bfde0196cef643ec95d0b3"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp39-cp39-win32.whl",
"has_sig": false,
"md5_digest": "06c9e70ff03e5c945095b485fb0ed9c0",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 86453,
"upload_time": "2023-06-05T08:50:38",
"upload_time_iso_8601": "2023-06-05T08:50:38.058447Z",
"url": "https://files.pythonhosted.org/packages/09/7a/1de77345674e167f63c64deffc83e0dba94f00ee28cbac1aaa4f0052b662/winfspy-0.8.4-cp39-cp39-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64b5d5898e727bf2c2911c0310da37dc867d8ef9d1b3678ee58b5add4a8418cb",
"md5": "aa35e716183165966812011a6d706751",
"sha256": "4fc6e7ed657e8d5218cb89e1a2867af2ce75553b33803368cb38b7f70ed377d1"
},
"downloads": -1,
"filename": "winfspy-0.8.4-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "aa35e716183165966812011a6d706751",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 95139,
"upload_time": "2023-06-05T08:50:39",
"upload_time_iso_8601": "2023-06-05T08:50:39.955082Z",
"url": "https://files.pythonhosted.org/packages/64/b5/d5898e727bf2c2911c0310da37dc867d8ef9d1b3678ee58b5add4a8418cb/winfspy-0.8.4-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9502a8046c785442e232121ff526d50057e27158c1f1e09f8a29d51960cad393",
"md5": "4657c23191a24d127a1d7339a50fc4af",
"sha256": "7870d16d74023fe5f0de98018fbc417319b02a2a5624a80fab3156d4c361a7f2"
},
"downloads": -1,
"filename": "winfspy-0.8.4.tar.gz",
"has_sig": false,
"md5_digest": "4657c23191a24d127a1d7339a50fc4af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58699,
"upload_time": "2023-06-05T08:50:41",
"upload_time_iso_8601": "2023-06-05T08:50:41.760689Z",
"url": "https://files.pythonhosted.org/packages/95/02/a8046c785442e232121ff526d50057e27158c1f1e09f8a29d51960cad393/winfspy-0.8.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-05 08:50:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Scille",
"github_project": "winfspy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "winfspy"
}
JSON
