Update initial app name across the repo

hakbailey · hakbailey · commit ba85f8581ecd · 2022-07-19T15:51:45.000-04:00
Why these changes are being introduced:
"app" was too generic a term to use as the initial app name. It meant a
find-and-replace across the repo would change many more things than the
actual app name (for example, documentation including the words "app" or
"application"). A better initial name is one that is not part of other
words and would *only* be used in places where the app name matters in
the code, making it easy to find and replace.

How this addresses that need:
* Replaces the app name "app" with "my_app" across the repo to ensure
  future users of this template can easily update the app name when
  first creating it.
diff --git a/Dockerfile b/Dockerfile
@@ -9,4 +9,4 @@ RUN apt-get update && apt-get upgrade -y && apt-get install -y git
 COPY Pipfile* /
 RUN pipenv install
 
-ENTRYPOINT ["pipenv", "run", "app"]
+ENTRYPOINT ["pipenv", "run", "my_app"]
diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@ update: install ## Update all Python dependencies
 ### Test commands ###
 
 test: ## Run tests and print a coverage report
-	pipenv run coverage run --source=app -m pytest -vv
+	pipenv run coverage run --source=my_app -m pytest -vv
 	pipenv run coverage report -m
 
 coveralls: test
@@ -24,13 +24,13 @@ coveralls: test
 lint: bandit black mypy pylama safety ## Run linting, code quality, and safety checks
 
 bandit:
-	pipenv run bandit -r app
+	pipenv run bandit -r my_app
 
 black:
 	pipenv run black --check --diff .
 
 mypy:
-	pipenv run mypy app
+	pipenv run mypy my_app
 
 pylama:
 	pipenv run pylama --options setup.cfg
diff --git a/Pipfile b/Pipfile
@@ -20,4 +20,4 @@ pytest = "*"
 python_version = "3.10"
 
 [scripts]
-app = "python -c \"from app.cli import main; main()\""
+my_app = "python -c \"from my_app.cli import main; main()\""
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ A template repository for creating Python CLI applications.
 
 ## App setup (delete this section and above after initial application setup)
 
-1. Rename "app" to the desired app name across the repo. (May be helpful to do a project-wide find-and-replace).
+1. Rename "my_app" to the desired app name across the repo. (May be helpful to do a project-wide find-and-replace).
 2. Update Python version if needed.
 3. Install all dependencies with `make install`  to create initial Pipfile.lock with latest dependency versions.
 4. Add initial app description to README and update initial required ENV variable documentation as needed.
@@ -20,7 +20,7 @@ A template repository for creating Python CLI applications.
    - Create an alert for the prod environment only, with notifications sent to the appropriate team(s).
    - If *not* using Sentry, delete Sentry configuration from config.py and test_config.py, and remove sentry_sdk from project dependencies.
 
-# app
+# my_app
 
 Description of the app
 
@@ -30,7 +30,7 @@ Description of the app
 - To update dependencies: `make update`
 - To run unit tests: `make test`
 - To lint the repo: `make lint`
-- To run the app: `pipenv run app --help`
+- To run the app: `pipenv run my_app --help`
 
 ## Required ENV
 
diff --git a/app/__init__.py b/app/__init__.py
diff --git a/my_app/__init__.py b/my_app/__init__.py
@@ -0,0 +1 @@
+"""my_app package."""
diff --git a/my_app/cli.py b/my_app/cli.py
@@ -4,7 +4,7 @@
 
 import click
 
-from app.config import configure_logger, configure_sentry
+from my_app.config import configure_logger, configure_sentry
 
 logger = logging.getLogger(__name__)
 
diff --git a/my_app/config.py b/my_app/config.py
@@ -12,7 +12,7 @@ def configure_logger(logger: logging.Logger, verbose: bool) -> str:
         )
         logger.setLevel(logging.DEBUG)
         for handler in logging.root.handlers:
-            handler.addFilter(logging.Filter("app"))
+            handler.addFilter(logging.Filter("my_app"))
     else:
         logging.basicConfig(
             format="%(asctime)s %(levelname)s %(name)s.%(funcName)s(): %(message)s"
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -1,4 +1,4 @@
-from app.cli import main
+from my_app.cli import main
 
 
 def test_cli_no_options(caplog, runner):
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -1,6 +1,6 @@
 import logging
 
-from app.config import configure_logger, configure_sentry
+from my_app.config import configure_logger, configure_sentry
 
 
 def test_configure_logger_not_verbose():

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ def configure_logger(logger: logging.Logger, verbose: bool) -> str:`
`12`	`12`	`)`
`13`	`13`	`logger.setLevel(logging.DEBUG)`
`14`	`14`	`for handler in logging.root.handlers:`
`15`		`- handler.addFilter(logging.Filter("app"))`
	`15`	`+ handler.addFilter(logging.Filter("my_app"))`
`16`	`16`	`else:`
`17`	`17`	`logging.basicConfig(`
`18`	`18`	`format="%(asctime)s %(levelname)s %(name)s.%(funcName)s(): %(message)s"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from app.cli import main`
	`1`	`+from my_app.cli import main`
`2`	`2`
`3`	`3`
`4`	`4`	`def test_cli_no_options(caplog, runner):`