Merge pull request #63 from nitrictech/develop

Release

Author: HomelessDinosaur

.gitignore

@@ -143,3 +143,5 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
+
+.vscode/

.pre-commit-config.yaml

@@ -8,4 +8,11 @@ repos:
     rev: 3.7.9
     hooks:
     - id: flake8
-      exclude: ^(venv|tests|build|dist|nitric/proto|examples)/
+      exclude: ^(venv|tests|build|dist|nitric/proto|examples)/
+-   repo: https://github.com/pycqa/pydocstyle
+    rev: 6.0.0
+    hooks:
+    -   id: pydocstyle
+        args:
+        - --ignore=D100, D105, D203, D212, D415
+        exclude: ^(venv|tests|build|dist|nitric/proto|examples)/

README.md

@@ -8,42 +8,36 @@
 
 # Nitric Python SDK
 
-The Python SDK supports the use of the cloud-portable [Nitric](https://nitric.io) framework with Python 3.7+.
+The Python SDK supports the use of the cloud-portable [Nitric](https://nitric.io) framework with Python 3.
 
 > The Nitric Python SDK is currently in Preview, API changes are likely prior to v1.x release.
 
 Read full documentation [here](https://nitrictech.github.io/python-sdk/).
 
-## Usage
+## Prerequisites
+
+- Python 3.8+
+
+## Getting Started
 
-### Nitric Functions (FaaS):
+### Using the [Nitric CLI](https://github.com/nitrictech/cli)
 
- - Install Python 3.7+
- - Install the [Nitric CLI](https://nitric.io/docs/installation?lang=python)
- - Create / Open a Nitric Project
- - Make a Python37 function
- 
- ```bash
-# Create a new project
-nitric make:project example-python
-cd example-python
+> nitric is included in all python related projects by default
 
-# Create a python37 Nitric Function
-nitric make:service function/python37 example-function
+```bash
+nitric stack new
 ```
 
-> note: The SDK will be included in the requirements.txt of a new Python function by default.
+Then select `official/Python Stack`
 
-### Standard Python Project
+### Adding to an existing project
 
- - Install Python 3.7+
+**pip**
 
 ```bash
 # Install the Nitric SDK
 pip3 install nitric
 ```
 
-```python
-# import classes/modules as required
-from nitric.api import Events, KeyValueClient
-```
+## Usage
+[Nitric Documentation](https://nitric.io/docs)

examples/events/event_ids.py

@@ -10,7 +10,7 @@ async def events_event_ids():
     payload = {"content": "of event"}
 
     # Publish an event to the topic 'my-topic'
-    event = await topic.publish(Event(payload=payload))
+    event = await topic.publish(Event(id="unique-event-id", payload=payload))
 
 
 # [END snippet]

examples/queues/failed.py

@@ -2,18 +2,21 @@
 from typing import List
 from nitric.api import Queues, Task
 from nitric.api.queues import FailedTask
+
 # [END import]
 async def queues_failed():
-# [START snippet]
-    # Construct a new queue client with default settings 
+    # [START snippet]
+    # Construct a new queue client with default settings
     queues = Queues()
 
     payload = {"content": "of task"}
 
     # Publish tasks to queue
     failed_task = await queues.queue("my-queue").send([Task(payload=payload) for i in range(2)])
-    
+
     # Process the failed task
     for task in failed_task:
-      print(task.message)
-# [END snippet]
+        print(task.message)
+
+
+# [END snippet]

examples/queues/send_id.py

@@ -0,0 +1,16 @@
+# [START import]
+from nitric.api import Queues, Task
+
+# [END import]
+async def queues_send():
+    # [START snippet]
+    # Construct a new queue client with default settings
+    queues = Queues()
+
+    payload = {"content": "of task"}
+
+    # Publish a task to a queue
+    await queues.queue("my-queue").send(Task(id="unique-task-id", payload=payload))
+
+
+# [END snippet]

examples/storage/sign_url_read.py

@@ -0,0 +1,15 @@
+# [START import]
+from nitric.api import Storage
+from nitric.api.storage import FileMode
+
+# [END import]
+async def storage_sign_url_read():
+    # [START snippet]
+    # Construct a new storage client with default settings
+    storage = Storage()
+
+    # Create a readonly presigned url for the file valid for the next 3600 seconds
+    await storage.bucket("my-bucket").file("path/to/item").sign_url(mode=FileMode.READ, expiry=3600)
+
+
+# [END snippet]

examples/storage/sign_url_write.py

@@ -0,0 +1,15 @@
+# [START import]
+from nitric.api import Storage
+from nitric.api.storage import FileMode
+
+# [END import]
+async def storage_sign_url_write():
+    # [START snippet]
+    # Construct a new storage client with default settings
+    storage = Storage()
+
+    # Create a writable presigned url for the file valid for the next 3600 seconds
+    await storage.bucket("my-bucket").file("path/to/item").sign_url(mode=FileMode.WRITE, expiry=3600)
+
+
+# [END snippet]

nitric/api/__init__.py

@@ -17,7 +17,7 @@
 # limitations under the License.
 #
 """Nitric API SDK."""
-from nitric.api.events import Events, Event, Topic
+from nitric.api.events import Events, Event, TopicRef
 from nitric.api.queues import Queues, Task, FailedTask
 from nitric.api.storage import Storage
 from nitric.api.documents import Documents
@@ -31,6 +31,6 @@
     "Event",
     "Task",
     "FailedTask",
-    "Topic",
+    "TopicRef",
     "Secrets",
 ]

nitric/api/events.py

@@ -46,7 +46,7 @@ def _event_to_wire(event: Event) -> NitricEvent:
 
 
 @dataclass(frozen=True, order=True)
-class Topic(object):
+class TopicRef(object):
     """A reference to a topic on an event service, used to perform operations on that topic."""
 
     _events: Events
@@ -94,14 +94,14 @@ def __del__(self):
         if self.channel is not None:
             self.channel.close()
 
-    async def topics(self) -> List[Topic]:
+    async def topics(self) -> List[TopicRef]:
         """Get a list of topics available for publishing or subscription."""
         try:
             response = await self._topic_stub.list()
             return [self.topic(topic.name) for topic in response.topics]
         except GRPCError as grpc_err:
             raise exception_from_grpc_error(grpc_err)
 
-    def topic(self, name: str) -> Topic:
+    def topic(self, name: str) -> TopicRef:
         """Return a reference to a topic."""
-        return Topic(_events=self, name=name)
+        return TopicRef(_events=self, name=name)