[MRG] Print survey link upon first launch of GUI or first import (#1158)

* Print survey link upon first launch of GUI or first import

* ref: rename survey, change to module install path

* doc: add recognition of user to changelog

* ref: move survey func into init

---------

Co-authored-by: Austin E. Soplata <me@asoplata.com>
Co-authored-by: Austin E. Soplata <asoplata@users.noreply.github.com>

Author: sketch123456

doc/whats_new.md

@@ -31,11 +31,18 @@ merged into `master`! Use `git log` instead and cross-reference instead. -->
 ### People who contributed to this release:
 
 - [Tushar Jamdade][]
+- [Karthikeya Kodlai][]
 
 ### Changelog
 
+- Add support for printing a welcome message that asks the user to fill out the HNN
+  survey, which is printed to the standard output after (and only after) the first time
+  the `hnn_core` module is imported. Whether or not the message is displayed is
+  determined by the presence of a new file created in the module after first run.
+  by [Karthikeya Kodlai][] in {gh}`1158`. This was their first PR, thanks Karthikeya!
+  
 - Add progressive minimal install and test to Github Actions,
-  by [Tushar Jamdade][] in {gh}`1214`.
+  by [Tushar Jamdade][] in {gh}`1214`. This was their first PR, thanks Tushar!
 
 ## 0.5.0 Release Notes
 
@@ -1254,4 +1261,5 @@ v0.4 represents a major milestone in development of `hnn_core` and the HNN ecosy
 [Maira Usman]: https://github.com/Myrausman
 [Chetan Kandpal]: https://github.com/Chetank99
 [NEURON]: https://nrn.readthedocs.io
-[Tushar Jamdade]: https://github.com/Tusharjamdade
+[Karthikeya Kodlai]: https://github.com/sketch123456
+[Tushar Jamdade]: https://github.com/Tusharjamdade

hnn_core/__init__.py

@@ -20,3 +20,34 @@
 )
 
 __version__ = "0.5.1.dev0"
+
+
+import json
+from pathlib import Path
+from textwrap import dedent
+
+
+def _print_survey_link():
+    """Print the survey link, unless the "seen" file already exists."""
+    storage_dir = Path(__file__).parent
+    storage_file = storage_dir / "survey_seen.json"
+
+    if not storage_file.exists():
+        print(
+            dedent("""
+        -------------------------------------------------------------------------------------------------------
+        Thank you for installing HNN-Core! Please fill out our survey at:
+
+            https://docs.google.com/forms/d/e/1FAIpQLSfN2F4IkGATs6cy1QBO78C6QJqvm9y14TqsCUsuR4Rrkmr1Mg/viewform
+
+        Filling out our survey REALLY helps us to provide support and maintenance for HNN-Core.
+
+        This message should only display once, after you have first installed HNN-Core. Happy modeling!
+        -------------------------------------------------------------------------------------------------------
+        """)
+        )
+        with open(storage_file, "w") as f:
+            json.dump({"survey_seen": True}, f)
+
+
+_print_survey_link()