Skip to content

Commit

Permalink
Merge branch 'release-1.10.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
mpenkov committed Mar 16, 2020
2 parents 6fd47d0 + 50d3610 commit 68c2d7f
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 5 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Unreleased

# 1.10.0, 16 Mar 2020

- Various webhdfs improvements (PR [#383](https://github.com/RaRe-Technologies/smart_open/pull/383), [@mrk-its](https://github.com/mrk-its))
- Fixes "the connection was closed by the remote peer" error (PR [#389](https://github.com/RaRe-Technologies/smart_open/pull/389), [@Gapex](https://github.com/Gapex))
- allow use of S3 single part uploads (PR [#400](https://github.com/RaRe-Technologies/smart_open/pull/400), [@adrpar](https://github.com/adrpar))
- Add test data in package via MANIFEST.in (PR [#401](https://github.com/RaRe-Technologies/smart_open/pull/401), [@jayvdb](https://github.com/jayvdb))
- Google Cloud Storage (GCS) (PR [#404](https://github.com/RaRe-Technologies/smart_open/pull/404), [@petedannemann](https://github.com/petedannemann))
- Implement to_boto3 function for S3 I/O. (PR [#405](https://github.com/RaRe-Technologies/smart_open/pull/405), [@mpenkov](https://github.com/mpenkov))
- enable smart_open to operate without docstrings (PR [#406](https://github.com/RaRe-Technologies/smart_open/pull/406), [@mpenkov](https://github.com/mpenkov))
- Implement object_kwargs parameter (PR [#411](https://github.com/RaRe-Technologies/smart_open/pull/411), [@mpenkov](https://github.com/mpenkov))
- Remove dependency on old boto library (PR [#413](https://github.com/RaRe-Technologies/smart_open/pull/413), [@mpenkov](https://github.com/mpenkov))
- implemented efficient readline for ByteBuffer (PR [#426](https://github.com/RaRe-Technologies/smart_open/pull/426), [@mpenkov](https://github.com/mpenkov))
- improve buffering efficiency (PR [#427](https://github.com/RaRe-Technologies/smart_open/pull/427), [@mpenkov](https://github.com/mpenkov))
- fix WebHDFS read method (PR [#433](https://github.com/RaRe-Technologies/smart_open/pull/433), [@mpenkov](https://github.com/mpenkov))
- Make S3 uploads more robust (PR [#434](https://github.com/RaRe-Technologies/smart_open/pull/434), [@mpenkov](https://github.com/mpenkov))

# 1.9.0, 3 Nov 2019

- Add version_id transport parameter for fetching a specific S3 object version (PR [#325](https://github.com/RaRe-Technologies/smart_open/pull/325), [@interpolatio](https://github.com/interpolatio))
Expand Down
24 changes: 20 additions & 4 deletions help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ DESCRIPTION
PACKAGE CONTENTS
bytebuffer
doctools
gcs
hdfs
http
s3
Expand Down Expand Up @@ -112,7 +113,11 @@ FUNCTIONS
is more ideal for small file sizes.
For writing only.
version_id: str, optional
Version of the object, used when reading object. If None, will fetch the most recent version.
Version of the object, used when reading object.
If None, will fetch the most recent version.
object_kwargs: dict, optional
Additional parameters to pass to boto3's object.get function.
Used during reading only.

HTTP (for details, see :mod:`smart_open.http` and :func:`smart_open.http.open`):

Expand Down Expand Up @@ -141,8 +146,12 @@ FUNCTIONS
user: str, optional
The username to use to login to the remote machine.
If None, defaults to the name of the current user.
password: str, optional
The password to use to login to the remote machine.
port: int, optional
The port to connect to.
transport_params: dict, optional
Any additional settings to be passed to paramiko.SSHClient.connect


Examples
Expand Down Expand Up @@ -190,6 +199,7 @@ FUNCTIONS
s3://my_bucket/my_key
s3://my_key:my_secret@my_bucket/my_key
s3://my_key:my_secret@my_server:my_port@my_bucket/my_key
gs://my_bucket/my_blob
hdfs:///path/file
hdfs://path/file
webhdfs://host:port/path/file
Expand All @@ -200,6 +210,7 @@ FUNCTIONS
file:///home/user/file
file:///home/user/file.bz2
[ssh|scp|sftp]://username@host//path/file
[ssh|scp|sftp]://username@host/path/file


See Also
Expand Down Expand Up @@ -230,7 +241,7 @@ FUNCTIONS
>>>
>>> register_compressor('.xz', _handle_xz)

s3_iter_bucket = iter_bucket(bucket_name, prefix='', accept_key=None, key_limit=None, workers=16, retries=3)
s3_iter_bucket = iter_bucket(bucket_name, prefix='', accept_key=None, key_limit=None, workers=16, retries=3, **session_kwargs)
Iterate and download all S3 objects under `s3://bucket_name/prefix`.

Parameters
Expand All @@ -249,6 +260,11 @@ FUNCTIONS
The number of subprocesses to use.
retries: int, optional
The number of time to retry a failed download.
session_kwargs: dict, optional
Keyword arguments to pass when creating a new session.
For a list of available names and values, see:
https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html#boto3.session.Session


Yields
------
Expand Down Expand Up @@ -282,9 +298,9 @@ DATA
__all__ = ['open', 'smart_open', 's3_iter_bucket', 'register_compresso...

VERSION
1.9.0
1.10.0

FILE
/Users/misha/git/smart_open/smart_open/__init__.py
/home/misha/git/smart_open/smart_open/__init__.py


2 changes: 1 addition & 1 deletion smart_open/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.9.0'
__version__ = '1.10.0'

0 comments on commit 68c2d7f

Please sign in to comment.