chore: more examples and readme updates (#517)

Author: anitarua

CONTRIBUTING.md

@@ -169,13 +169,18 @@ poetry run isort .
 
 ## Tests :zap:
 
-Integration tests require an api key for testing. Set the env vars `MOMENTO_API_KEY` and `MOMENTO_ENDPOINT` to
-provide it. The env `TEST_CACHE_NAME` is also required, but for now any string value works.
+Integration tests require the env vars `MOMENTO_API_KEY`, `MOMENTO_ENDPOINT`, and `V1_API_KEY`. 
+The env var `TEST_CACHE_NAME` is also required, but for now any string value works.
 
 Example of running tests against all python versions:
 
 ```
-MOMENTO_API_KEY=<api key> MOMENTO_ENDPOINT=<endpoint> TEST_CACHE_NAME=<cache name> poetry run pytest
+MOMENTO_API_KEY=<v2 api key> 
+MOMENTO_ENDPOINT=<endpoint> 
+V1_API_KEY=<v1 api key>
+TEST_CACHE_NAME=<cache name> 
+
+poetry run pytest
 ```
 
 ### For M1 Users
@@ -188,7 +193,7 @@ a github issue with us to let us know.  And in the meantime you can work around
 issue by installing Rosetta 2 and re-running with:
 
 ```
-arch -x86_64 MOMENTO_API_KEY=<api key> MOMENTO_ENDPOINT=<endpoint>  TEST_CACHE_NAME=<cache name> poetry run pytest
+arch -x86_64 MOMENTO_API_KEY=<v2 api key> MOMENTO_ENDPOINT=<endpoint> V1_API_KEY=<v1 api key> TEST_CACHE_NAME=<cache name> poetry run pytest
 ```
 
 ### Developing new test cases?

README.template.md

@@ -4,10 +4,12 @@
 
 The Momento Python SDK package is available on pypi: [momento](https://pypi.org/project/momento/).
 
-## Usage
+## Prerequisites
+
+- A Momento API key is required, you can generate one using the [Momento Console](https://console.gomomento.com/api-keys)
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions)
 
-The examples below require an environment variable named `MOMENTO_API_KEY` which must
-be set to a valid Momento API key. You can get one from the [Momento Console](https://console.gomomento.com).
+## Usage
 
 Python 3.10 introduced the `match` statement, which allows for [structural pattern matching on objects](https://peps.python.org/pep-0636/#adding-a-ui-matching-objects).
 If you are running python 3.10 or greater, here is a quickstart you can use in your own project:
@@ -32,8 +34,8 @@ Documentation is available on the [Momento Docs website](https://docs.momentohq.
 Working example projects, with all required build configuration files, are available for both Python 3.10 and up
 and Python versions before 3.10:
 
-* [Python 3.10+ examples](./examples/py310)
-* [Pre-3.10 Python examples](./examples/prepy310)
+- [Python 3.10+ examples](./examples/py310)
+- [Pre-3.10 Python examples](./examples/prepy310)
 
 ## Developing
 

examples/lambda/README.md

@@ -17,7 +17,8 @@ The primary use is to provide a base for testing Momento in an AWS lambda enviro
 ## Prerequisites
 
 - Node version 14 or higher is required (for deploying the Cloudformation stack containing the Lambda)
-- To get started with Momento you will need a Momento Auth Token. You can get one from the [Momento Console](https://console.gomomento.com). Check out the [getting started](https://docs.momentohq.com/getting-started) guide for more information on obtaining an auth token.
+- A Momento API key is required, you can generate one using the [Momento Console](https://console.gomomento.com/api-keys)
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions)
 
 ## Deploying the Momento Python Lambda with Docker and AWS CDK
 
@@ -31,12 +32,11 @@ npm install
 
 To deploy the CDK app you will need to have [configured your AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html#cli-chap-authentication-precedence).
 
-You will also need a superuser token generated from the [Momento Console](https://console.gomomento.com).
-
 Then run:
 
 ```
-export MOMENTO_API_KEY=<YOUR_MOMENTO_API_KEY>
+export MOMENTO_API_KEY=<your-api-key>
+export MOMENTO_ENDPOINT=<your-endpoint>
 npm run cdk deploy
 ```
 
@@ -63,4 +63,5 @@ Follow these steps to create the zip and deploy it to AWS Lambda using the AWS M
 8. Under "Runtime settings", set the Handler to index.handler.
 9. Switch to the "Configuration" tab.
 10. Set the environment variable `MOMENTO_API_KEY` to your API key.
-11. Finally, go to the "Test" tab to test your Lambda function.
+11. Set the environment variable `MOMENTO_ENDPOINT` to your chosen endpoint.
+12. Finally, go to the "Test" tab to test your Lambda function.

examples/lambda/docker/lambda/index.py

@@ -8,7 +8,7 @@ def handler(event, lambda_context):
     cache_name = "default-cache"
     with CacheClient.create(
         configuration=Configurations.Lambda.latest(),
-        credential_provider=CredentialProvider.from_environment_variable("MOMENTO_API_KEY"),
+        credential_provider=CredentialProvider.from_environment_variables_v2(),
         default_ttl=timedelta(seconds=60),
     ) as cache_client:
         create_cache_response = cache_client.create_cache(cache_name)

examples/lambda/docker/lambda/requirements.txt

@@ -1 +1 @@
-momento==1.8.0
+momento==1.28.0

examples/lambda/infrastructure/lib/stack.ts

@@ -1,6 +1,6 @@
 import * as path from 'path';
 import * as cdk from 'aws-cdk-lib';
-import {Construct} from 'constructs';
+import { Construct } from 'constructs';
 import * as lambda from 'aws-cdk-lib/aws-lambda';
 
 export class MomentoLambdaStack extends cdk.Stack {
@@ -10,13 +10,17 @@ export class MomentoLambdaStack extends cdk.Stack {
         if (!process.env.MOMENTO_API_KEY) {
             throw new Error('The environment variable MOMENTO_API_KEY must be set.');
         }
+        if (!process.env.MOMENTO_ENDPOINT) {
+            throw new Error('The environment variable MOMENTO_ENDPOINT must be set.');
+        }
 
         // Create Lambda function from Docker Image
         const dockerLambda = new lambda.DockerImageFunction(this, 'MomentoDockerLambda', {
             functionName: 'MomentoDockerLambda',
             code: lambda.DockerImageCode.fromImageAsset(path.join(__dirname, '../../docker')), // Point to the root since Dockerfile should be there
             environment: {
-                MOMENTO_API_KEY: process.env.MOMENTO_API_KEY || ''
+                MOMENTO_API_KEY: process.env.MOMENTO_API_KEY || '',
+                MOMENTO_ENDPOINT: process.env.MOMENTO_ENDPOINT || ''
             },
             memorySize: 128,
             timeout: cdk.Duration.seconds(30)

examples/lambda/zip/index.py

@@ -8,7 +8,7 @@ def handler(event, lambda_context):
     cache_name = "default-cache"
     with CacheClient.create(
         configuration=Configurations.Lambda.latest(),
-        credential_provider=CredentialProvider.from_environment_variable("MOMENTO_API_KEY"),
+        credential_provider=CredentialProvider.from_environment_variables_v2(),
         default_ttl=timedelta(seconds=60),
     ) as cache_client:
         create_cache_response = cache_client.create_cache(cache_name)

examples/lambda/zip/requirements.txt

@@ -1 +1 @@
-momento==1.20.1
+momento==1.28.0

examples/py310/doc-examples-python-apis.py

@@ -44,6 +44,15 @@ def example_API_CredentialProviderFromEnvVar():
 
 
 def example_API_CredentialProviderFromEnvVarV2():
+    CredentialProvider.from_environment_variables_v2(
+        api_key_env_var="MOMENTO_API_KEY", endpoint_env_var="MOMENTO_ENDPOINT"
+    )
+
+
+# end example
+
+
+def example_API_CredentialProviderFromEnvVarV2Default():
     CredentialProvider.from_environment_variables_v2()
 
 
@@ -233,6 +242,7 @@ async def example_API_GenerateDisposableToken(auth_client: AuthClientAsync):
 async def main():
     example_API_CredentialProviderFromEnvVar()
     example_API_CredentialProviderFromEnvVarV2()
+    example_API_CredentialProviderFromEnvVarV2Default()
     example_API_CredentialProviderFromApiKeyV2()
     example_API_CredentialProviderFromDisposableToken()