Tidying up duplication between /docs and docs.datafold.com (#495)

* remove how to use file, which is duplicative of docs.datafold.com * post questions in github discussions * update docs/index.rst * remove use cases * Create python_examples.rst --------- Co-authored-by: Will Sweet <[email protected]>
datafold · Apr 13, 2023 · 25692cb · 25692cb
1 parent ed971de
commit 25692cb
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 196 deletions.
diff --git a/README.md b/README.md
@@ -32,26 +32,6 @@ For their corresponding connection strings, check out our [detailed table](https
 #### Looking for a database not on the list?
 If a database is not on the list, we'd still love to support it. [Please open an issue](https://github.com/datafold/data-diff/issues) to discuss it, or vote on existing requests to push them up our todo list.
 
-## Use cases
-
-### Diff Tables Between Databases
-#### Quickly identify issues when moving data between databases
-
-<p align="center">
-  <img alt="diff2" src="https://user-images.githubusercontent.com/1799931/196754998-a88c0a52-8751-443d-b052-26c03d99d9e5.png" />
-</p>
-
-### Diff Tables Within a Database
-#### Improve code reviews by identifying data problems you don't have tests for
-<p align="center">
-  <a href=https://www.loom.com/share/682e4b7d74e84eb4824b983311f0a3b2 target="_blank">
-    <img alt="Intro to Diff" src="https://user-images.githubusercontent.com/1799931/196576582-d3535395-12ef-40fd-bbbb-e205ccae1159.png" width="50%" height="50%" />
-  </a>
-</p>
-
-&nbsp;
-&nbsp;
-
 ## Get started
 
 ### Installation
@@ -126,10 +106,7 @@ In both code examples, I've used `<>` carrots to represent values that **should
 
 ### We're here to help!
 
-We know that in some cases, the data-diff command can become long and dense. And maybe you're new to the command line.
-
-* We're here to help [on slack](https://getdbt.slack.com/archives/C03D25A92UU) if you have ANY questions as you use `data-diff` in your workflow.
-* You can also post a question in [GitHub Discussions](https://github.com/datafold/data-diff/discussions).
+We're here to help! Please post any questions in [GitHub Discussions](https://github.com/datafold/data-diff/discussions).
 
 ## How to Use
 

diff --git a/docs/how-to-use.md b/docs/how-to-use.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,22 +4,12 @@
    :hidden:
 
    python-api
+   python_examples
 
 data-diff
 ---------
 
-**Data-diff** is a command-line tool and Python library to efficiently diff
-rows across two different databases.
-
-⇄  Verifies across many different databases (e.g. *PostgreSQL* -> *Snowflake*) !
-
-🔍 Outputs diff of rows in detail
-
-🚨 Simple CLI/API to create monitoring and alerts
-
-🔥 Verify 25M+ rows in <10s, and 1B+ rows in ~5min.
-
-♾️  Works for tables with 10s of billions of rows
+**Data-diff** is a command-line tool and Python library for comparing tables in and across databases.
 
 For more information, `See our README <https://github.com/datafold/data-diff#readme>`_
 
@@ -32,4 +22,4 @@ Resources
 - :doc:`python-api`
 - The rest of the `documentation`_
 
-.. _documentation: https://docs.datafold.com/os_diff/about/
+.. _documentation: https://docs.datafold.com/guides/os_data_diff
diff --git a/docs/python_examples.rst b/docs/python_examples.rst
@@ -0,0 +1,44 @@
+Python API Examples
+---------
+
+**Example 1: Diff tables in mysql and postgresql**
+
+.. code-block:: python
+    # Optional: Set logging to display the progress of the diff
+    import logging
+    logging.basicConfig(level=logging.INFO)
+
+    from data_diff import connect_to_table, diff_tables
+
+    table1 = connect_to_table("postgresql:///", "table_name", "id")
+    table2 = connect_to_table("mysql:///", "table_name", "id")
+
+    for different_row in diff_tables(table1, table2):
+        plus_or_minus, columns = different_row
+        print(plus_or_minus, columns)
+
+
+**Example 2: Connect to snowflake using dictionary configuration**
+
+.. code-block:: python
+    SNOWFLAKE_CONN_INFO = {
+        "driver": "snowflake",
+        "user": "erez",
+        "account": "whatever",
+        "database": "TESTS",
+        "warehouse": "COMPUTE_WH",
+        "role": "ACCOUNTADMIN",
+        "schema": "PUBLIC",
+        "key": "snowflake_rsa_key.p8",
+    }
+
+    snowflake_table = connect_to_table(SNOWFLAKE_CONN_INFO, "table_name")  # Uses id by default
+
+Run `help(connect_to_table)` and `help(diff_tables)` or read our API reference to learn more about the different options:
+
+- connect_to_table_
+
+- diff_tables_
+
+.. _connect_to_table: https://data-diff.readthedocs.io/en/latest/python-api.html#data_diff.connect_to_table
+.. _diff_tables: https://data-diff.readthedocs.io/en/latest/python-api.html#data_diff.diff_tables