Update readme

README.md

@@ -4,10 +4,6 @@
 
 Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
 
-<!--
-
-Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.
-
 ## Installation
 
 Install from PyPi:
@@ -19,24 +15,20 @@ pipx install tap-datadog
 Install from GitHub:
 
 ```bash
-pipx install git+https://github.com/ORG_NAME/tap-datadog.git@main
+pipx install git+https://github.com/immuta/tap-datadog.git@main
 ```
 
--->
-
 ## Configuration
 
 ### Accepted Config Options
 
-<!--
-Developer TODO: Provide a list of config options accepted by the tap.
+## Settings
 
-This section can be created by copy-pasting the CLI output from:
-
-```
-tap-datadog --about --format=markdown
-```
--->
+| Setting | Required | Default | Description |
+|:--------|:--------:|:-------:|:------------|
+| api_key | True     | None    | The API Key, generated in Datadog UI and stored in 1Password |
+| application_key | True     | None    | The Application Key, generated in Datadog UI and stored in 1Password |
+| slos | True     | None    | SLOs to replicate |
 
 A full list of supported settings and capabilities for this
 tap is available by running:
@@ -53,9 +45,7 @@ environment variable is set either in the terminal context or in the `.env` file
 
 ### Source Authentication and Authorization
 
-<!--
-Developer TODO: If your tap requires special access on the source system, or any special authentication requirements, provide those here.
--->
+An API Key and Application Key from Datadog must be provided in the `config.json`.
 
 ## Usage
 
@@ -100,12 +90,6 @@ poetry run tap-datadog --help
 _**Note:** This tap will work in any Singer environment and does not require Meltano.
 Examples here are for convenience and to streamline end-to-end orchestration scenarios._
 
-<!--
-Developer TODO:
-Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any "TODO" items listed in
-the file.
--->
-
 Next, install Meltano (if you haven't already) and any needed plugins:
 
 ```bash

meltano.yml

@@ -0,0 +1,30 @@
+version: 1
+send_anonymous_usage_stats: true
+project_id: "tap-datadog"
+default_environment: test
+environments:
+- name: test
+plugins:
+  extractors:
+  - name: "tap-datadog"
+    namespace: "tap_datadog"
+    pip_url: -e .
+    capabilities:
+    - state
+    - catalog
+    - discover
+    - about
+    - stream-maps
+    config:
+      start_date: '2010-01-01T00:00:00Z'
+    settings:
+    # TODO: To configure using Meltano, declare settings and their types here:
+    - name: username
+    - name: password
+      kind: password
+    - name: start_date
+      value: '2010-01-01T00:00:00Z'
+  loaders:
+  - name: target-jsonl
+    variant: andyh1203
+    pip_url: target-jsonl

tap_datadog/tap.py

@@ -22,29 +22,24 @@ class Tapdatadog(Tap):
             th.StringType,
             required=True,
             secret=True,  # Flag config as protected.
-            description="The API Key",
+            description="The API Key, generated in Datadog UI and stored in 1Password",
         ),
         th.Property(
             "application_key",
             th.StringType,
             required=True,
             secret=True,  # Flag config as protected.
-            description="The Application Key",
+            description="The Application Key, generated in Datadog UI and stored in 1Password",
         ),
         th.Property(
             "slos",
             th.ArrayType(th.ObjectType(
                 th.Property("name", th.StringType, description="The name of the SLO"),
-                th.Property("id", th.StringType, description="The id of the SLO")
+                th.Property("id", th.StringType, description="The id of the SLO"),
             )),
             required=True,
-            description="SLO IDs to replicate",
+            description="SLOs to replicate",
         ),
-        th.Property(
-            "start_date",
-            th.DateTimeType,
-            description="The earliest record date to sync",
-        )
     ).to_dict()
 
     def discover_streams(self) -> list[streams.datadogStream]: