deploy: a6d8e98

Author: byteskeptical

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5b6a16e62f5fa14c7a6c048f82baf9a3
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.nojekyll

@@ -0,0 +1,15 @@
+Authors
+=======
+Contributors of code, tests and documentation to the project who have agreed to have their work enjoined into the project and project license (BSD).
+
+
+Acknowledgment
+--------------
+    * PR #46 by ofiliojo
+    * PR #19 by coreyhartley
+    * PR #15 by RobertCochran
+    * PR #12 by erans
+    * ftpretty by codebynumbers
+    * pysftp by dundeemt
+    * paramiko by Robey Pointer
+    * ssh.py by Zeth

_sources/authors.rst.txt

@@ -0,0 +1,122 @@
+1.1.10 (current, released 2025-10-14)
+-----------------------------------
+    * fix for channel re-use limitation.
+    * regression fix for properly closing channel cache sockets.
+
+1.1.9 (released 2025-8-06)
+-----------------------------------
+    * adding channel cache to place upper limit on creation overhead.
+    * removing ssh-dss key type as it was deprecated in paramiko in 4.0.0.
+
+1.1.8 (released 2025-6-13)
+--------------------------
+    * added WARN log level to logger, mapped to QUIET in ssh config.
+    * added support for int values in CnOpts.log_level mapped to python logging.
+
+1.1.7 (released 2025-2-22)
+--------------------------
+    * bug fix for host key matching servers running on non default ports
+
+1.1.6 (released 2024-10-12)
+---------------------------
+    * added AES-GCM ciphers
+
+1.1.5 (released 2024-6-30)
+--------------------------
+    * added API diff table
+    * added CnOpts.get_agentkey
+    * adding support/testing for python 3.12
+    * switched to pyproject.toml from setup.py
+
+1.1.4 (released 2024-1-04)
+--------------------------
+    * missed the console logger in previous behavior change
+
+1.1.3 (released 2023-12-11)
+---------------------------
+    * adding merge between ssh security options and paramiko compatibility
+    * changing default logger behavior from hooking into __main__
+
+1.1.2 (released 2023-10-24)
+---------------------------
+    * added support for setting max_workers on ThreadPool functions
+
+1.1.1 (released 2023-08-28)
+---------------------------
+    * added initial support for resuming existing transfers get() & put()
+    * added max_concurrent_prefetch_requests parameter to get() family
+    * added prefetch parameter to get() family
+
+1.1.0 (released 2023-08-15)
+---------------------------
+    * added initial support for OpenSSH config-file support to CnOpts
+
+1.0.9 (released 2023-05-08)
+---------------------------
+    * added drivedrop to bypass _adjust_cwd's lack of Windows drive support
+    * added file_size logic and default remotepath fallback to putfo
+    * moved Connection.compress to CnOpts.compress
+    * regression in put_d *again*
+    * removed SKIP_IF_CI from all but one test in response to the above
+    * switched to public key auth for all tests !¿macOS?¡
+    * switched from get_fingerprint() using md5 to helpers.hash using sha3_256
+    * test clean-up and major refactor
+
+1.0.7 (released 2023-02-27)
+---------------------------
+    * fix regression in put_d
+
+1.0.6 (released 2023-01-15)
+---------------------------
+    * allow CnOpts knownhost to be set to None directly
+    * standardize on using is for None checks 
+
+1.0.5 (released 2022-11-29)
+---------------------------
+    * added log_level to connection options
+    * added compression security option for Transport
+    * code optimizations in _start_transport() and _set_authentication()
+    * moved compression on/off switch to Connection object
+    * sprinkled debug messaging throughout
+    * switched to using native logging module instead of paramiko util
+
+1.0.4 (released 2022-09-24)
+---------------------------
+    * added Windows Pure Path logic in put_d() and put_r() through localtree()
+    * fix for regression in _sftp_channel() causing UnboundLocalError
+    * improved support for dot notation in known_hosts and private key file
+    * removed basicConfig() call for improved embedded behavior
+
+1.0.3 (released 2022-09-13)
+---------------------------
+    * added disabled algorithms option for Transport
+
+1.0.2 (released 2022-09-09)
+---------------------------
+    * added sort to localtree() for test continuity
+    * bug fix for typo in put_d()
+
+1.0.1 (released 2022-07-22)
+---------------------------
+    * added key types security option for Transport
+    * bug fixes for close()
+    * default to private key authentication
+    * enabled timeout setting for channel and transport
+    * improved host key logging
+    * localtree & remotetree functions Windows compatible
+    * started hosting on PyPi
+    * updated tests and CI pipeline 
+
+1.0.0 (released 2021-06-06)
+---------------------------
+    * added ECDSA and ED25519 key support for authentication
+    * added digest and kex security options for Transport
+    * added tests for additional functionality
+    * default callback function for progress notifications
+    * hash function added to helpers for file verification option
+    * improved local and remote directory mapping
+    * improved logging capabilities
+    * replaced _sftp_connect with context aware channel manager
+    * retry decorator for automated recovery from failure
+    * switched to using pathlib for all local filepath operations
+    * updated documentation and README with advanced examples

_sources/changes.rst.txt

@@ -0,0 +1,43 @@
+Contributing
+============
+You can contribute to the project in a number of ways. Code is always good, bugs are interesting but tests make your famous!
+
+Bug reports or feature enhancements that include a test are given preferential treatment. So instead of voting for an issue, write a test.
+
+Bug Reports
+-----------
+If you encounter a bug or some surprising behavior, please file an issue on our `tracker <https://github.com/byteskeptical/sftpretty/issues>`_.
+
+Code
+----
+    #. Fork the repository `sftpretty <https://github.com/byteskeptical/sftpretty>`_
+    #. Install supporting software packages and sftpretty in --editable mode
+
+        a. Make a virtualenv, clone the repos, install the deps from pip install -r requirements-dev.txt
+        b. Install sftpretty in editable mode, pip install -e .
+    #. Write any new tests needed and ensure existing tests continue to pass without modification.
+
+        a. Setup CI testing for your Fork. Currently testing is done on Github Actions but feel free to use the testing framework of your choosing.
+        b. Testing features that concern chmod, chown on Windows is NOT supported. Testing compression has to be ran against a local compatible sshd and not the plugin as it does NOT support this test.
+        c. You will need to setup an ssh daemon on your local machine and create a user: copy the contents of id_sftpretty.pub to the newly created user's authorized_keys file -- Tests that can only be run locally are skipped using the @skip_if_ci decorator so they don't fail when the test suite is run on the CI server.
+
+    #. Ensure that your name is added to the end of the :doc:`authors` file using the format Name <email@domain.com> (url), where the (url) portion is optional.
+    #. Submit a Pull Request to the project.
+
+Docs
+----
+Using Sphinx to build the docs. ``make html`` is your friend, see docstrings for details on params, etc.
+
+Issue Priorities
+----------------
+This section lists the priority that will be assigned to an issue:
+    #. Developer Issues
+    #. Issues that have a pull request with a test(s) displaying the issue and code change(s) that satisfies the test suite
+    #. Issues that have a pull request with a test(s) displaying the issue
+    #. Naked pull requests - a code change request with no accompaning test
+    #. An issue without a pull request with a test displaying the issue
+    #. Badly documented issue with no code or test - sftpretty is not an end-user tool, it is a developer tool and it is expected that issues will be submitted like a developer and not an end-user. Issues in the realm of "the internet is broken" will be marked as invalid with a comment pointing the submitter to this section.
+
+Testing
+-------
+Tests specific to an issue should be put in the tests/ directory and the module should be named test_issue_xx.py The tests within that module should be named test_issue_xx or test_issue_xx_YYYYYY if more than one test. Pull requests should not modify existing tests (exceptions apply). See tests/test_issue_xx.py for a template and further explanation.