Migrate to s3dol

.github/workflows/ci.yml

@@ -28,6 +28,9 @@ jobs:
       - name: Format source code
         run: black  --line-length=88 .
 
+      - name: S3 Localstack
+        run: docker run -d -e SERVICES=s3 -p 4566:4566 --name localstack localstack/localstack
+
       # Documentation on "enable" codes:
       #     http://pylint.pycqa.org/en/latest/technical_reference/features.html#basic-checker-messages
       # C0114: missing-module-docstring
@@ -37,7 +40,13 @@ jobs:
         run: pylint ./$PROJECT_NAME --ignore=tests,examples --disable=all --enable=C0114
 
       - name: Test
-        run: pytest --doctest-modules -v $PROJECT_NAME
+        run: |
+          export S3_TEST_ENDPOINT_RW=http://localhost:4566
+          export S3_TEST_BUCKET_RW=test-bucket
+          export S3_TEST_ACCESS_RW=access
+          export S3_TEST_SECRET_RW=secret
+          pytest --doctest-modules -v $PROJECT_NAME
+
   publish:
     name: Publish
     if: "!contains(github.event.head_commit.message, '[skip ci]') && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main')"
@@ -76,19 +85,24 @@ jobs:
           echo "VERSION=$VERSION" >> $GITHUB_ENV
           isee update-setup-cfg
 
-      - name: Generate Documentation
-        run: isee generate-documentation
-
       - name: Package
         run: python setup.py sdist
 
       - name: Publish
         run: |
           twine upload dist/$PROJECT_NAME-$VERSION.tar.gz -u ${{ secrets.PYPI_USERNAME }} -p ${{ secrets.PYPI_PASSWORD }} --non-interactive  --skip-existing --disable-progress-bar
-          epythet make . github
 
       - name: Push Changes
         run: pack check-in "**CI** Formatted code + Updated version number and documentation. [skip ci]" --auto-choose-default-action --bypass-docstring-validation --bypass-tests --bypass-code-formatting --verbose
 
       - name: Tag Repository
         run: isee tag-repo $VERSION
+
+  github-pages:
+    name: Publish GitHub Pages
+    needs: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: i2mint/epythet/actions/publish-github-pages@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -113,3 +113,6 @@ venv.bak/
 
 # PyCharm
 .idea
+
+# Visual Studio Code
+.vscode/

README.md

@@ -4,3 +4,36 @@ s3 (through boto3) with a simple (dict-like or list-like) interface
 
 
 To install:	```pip install s3dol```
+
+
+## Set up credentials
+Recommended prerequisite to make getting started easier but not required.
+
+### Option 1: [Environment Variables](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html)
+```
+export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+export AWS_DEFAULT_REGION=us-west-2
+```
+
+### Option 2: [Configure Default Profile in Credentials File](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html)
+Add credentails in `~/.aws/credentials`
+```
+[default]
+aws_access_key_id = AKIAIOSFODNN7EXAMPLE
+aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+```
+
+### Option 3: [Configure Default Profile with AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/configure/)
+[Install AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+```bash
+brew instal awscli
+```
+Set credentails with CLI
+```bash
+aws configure
+AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
+AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+Default region name [None]: us-west-2
+Default output format [None]:
+```