Add DeprecationWarnings to fidesctl (#1244)

* Add `DeprecationWarnings` to fidesctl * add a deprecation warning to the CLI * remove analytics ID * add a deprecation warning that gets logged on the server * update changelog * update changelog for final release * Update src/fidesctl/api/main.py Co-authored-by: Steve Murphy <[email protected]> * Update src/fidesctl/cli/__init__.py Co-authored-by: Steve Murphy <[email protected]> Co-authored-by: Steve Murphy <[email protected]>
ethyca · Oct 6, 2022 · f2403c9 · f2403c9
1 parent 7aa67b8
commit f2403c9
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 7 deletions.
diff --git a/.fides/fidesctl.toml b/.fides/fidesctl.toml
@@ -1,10 +1,10 @@
 [database]
-server="fidesctl-db"
-user="postgres"
-password="fidesctl"
-port="5432"
-db="fidesctl"
-test_db="fidesctl_test"
+server = "fidesctl-db"
+user = "postgres"
+password = "fidesctl"
+port = "5432"
+db = "fidesctl"
+test_db = "fidesctl_test"
 
 [logging]
 level = "INFO"

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,11 @@ The types of changes are:
 * `Fixed` for any bug fixes.
 * `Security` in case of vulnerabilities.
 
-## [Unreleased](https://github.com/ethyca/fides/compare/1.9.1...main)
+## [1.9.2](https://github.com/ethyca/fides/compare/1.9.2...main)
+
+### Deprecated
+
+* Added a deprecation warning for the entire package [#1244](https://github.com/ethyca/fides/pull/1244)
 
 ### Added
 
@@ -60,6 +64,7 @@ The types of changes are:
 * Dataset fields table shows categories in the last column. [#1088](https://github.com/ethyca/fides/pull/1088)
 
 ### Docs
+
 * Updated the footer links [#1130](https://github.com/ethyca/fides/pull/1130)
 
 ### Fixed

diff --git a/src/fidesctl/api/main.py b/src/fidesctl/api/main.py
@@ -80,6 +80,11 @@ async def setup_server() -> None:
     )
 
     log.bind(api_config=CONFIG.logging.json()).debug("Configuration options in use")
+
+    docs_link = "https://ethyca.github.io/fides/"
+    log.warning(
+        f"WARNING: 'Fidesctl' has been deprecated and replaced by a more robust 'Fides' tool, which includes existing 'fidesctl' functionality. Run `pip install ethyca-fides` to get the latest version of Fides and visit '{docs_link}' for up-to-date documentation.\n"
+    )
     await configure_db(CONFIG.database.sync_database_uri)
 
 

diff --git a/src/fidesctl/cli/__init__.py b/src/fidesctl/cli/__init__.py
@@ -59,6 +59,11 @@ def cli(ctx: click.Context, config_path: str, local: bool) -> None:
     The parent group for the Fidesctl CLI.
     """
 
+    docs_link = "https://ethyca.github.io/fides/"
+    click.secho(
+        f"WARNING: 'Fidesctl' has been deprecated and replaced by a more robust 'Fides' tool, which includes existing 'fidesctl' functionality. Run `pip install ethyca-fides` to get the latest version of Fides and visit '{docs_link}' for up-to-date documentation.\n",
+        fg="red",
+    )
     ctx.ensure_object(dict)
     config = get_config(config_path)