Added endpoint_url to opener and docs (#11)

* Typo in credential URL syntax

* Fixing any typos I see as I find them

* add `endpoint_url` to opener, so it can be passed as a URL parameter (for use in open_fs)

* added `endpoint_url` examples

* copy of README.md

* copy of README.md

* Reverted to original and added `endpoint_url` example

README.md

@@ -11,17 +11,21 @@ same way as any other supported filesystem.
 
 Open an S3FS by explicitly using the constructor:
 
-```python
-from s3_s3fs import s3FS
-s3fs = S3FS('mybucket')
-```
-
-Or with a FS URL:
-
-```python
-from fs import open_fs
-s3fs = open_fs('s3://mybucket')
-```
+ ```python
+  from s3_s3fs import s3FS
+  s3fs = S3FS('mybucket')
+  # to use an s3-compatible service
+  s3fs = S3FS('mybucket', endpoint_url='service.endpoint.url')
+  ```
+
+  Or with a FS URL:
+
+  ```python
+  from fs import open_fs
+  s3fs = open_fs('s3://mybucket')
+  # to use an s3-compatible service
+  s3fs = open_fs('s3://mybucket?endpoint_url=service.endpoint.url')
+  ```
 
 ## Downloading Files
 

README.rst

@@ -17,13 +17,17 @@ Open an S3FS by explicitly using the constructor:
 
     from s3_s3fs import s3FS
     s3fs = S3FS('mybucket')
+    # to use an s3-compatible service
+    s3fs = S3FS('mybucket', endpoint_url='service.endpoint.url')
 
 Or with a FS URL:
 
 .. code:: python
 
     from fs import open_fs
     s3fs = open_fs('s3://mybucket')
+    # to use an s3-compatible service
+    s3fs = open_fs('s3://mybucket?endpoint_url=service.endpoint.url')
 
 Downloading Files
 -----------------

docs/index.rst

@@ -54,7 +54,7 @@ and secret key configured on your system. You may also specify when
 creating the filesystem instance. Here's how you would do that with an
 opener::
 
-    s3fs = open_fs('s3://<access key>:<secret key>/mybucket')
+    s3fs = open_fs('s3://<access key>:<secret key>@mybucket')
 
 Here's how you specify credentials with the constructor::
 

fs_s3fs/opener.py

@@ -27,5 +27,6 @@ def open_fs(self, fs_url, parse_result, writeable, create, cwd):
             dir_path=dir_path or '/',
             aws_access_key_id=parse_result.username or None,
             aws_secret_access_key=parse_result.password or None,
+            endpoint_url=parse_result.params.get('endpoint_url', None)
         )
         return s3fs