Updated docs image, cookiecutter params and tests.yml file name

Author: rafsaf

.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: tests
+name: Run tests
 
 on:
   push:

cookiecutter.json

@@ -1,4 +1,4 @@
 {
-  "project_name": "Base Project",
-  "use_fastapi_users": false
+  "project_name": "my_project_name",
+  "experimental_fastapi_users_template": false
 }

docs/template-minimal-openapi-example.png

@@ -8,7 +8,7 @@
 from shutil import copytree, rmtree
 
 PROJECT_NAME = "{{ cookiecutter.project_name }}"
-USE_FASTAPI_USERS = "{{ cookiecutter.use_fastapi_users }}"
+USE_FASTAPI_USERS = "{{ cookiecutter.experimental_fastapi_users_template }}"
 TEMPLATES = ["template_fastapi_users", "template_minimal"]
 
 
@@ -38,7 +38,7 @@ def create_env_file_and_remove_env_template():
     elif USE_FASTAPI_USERS in falsy:
         used_template = "template_minimal"
     else:
-        raise ValueError(f"use_fastapi_users param must be in {truthy + falsy}")
+        raise ValueError(f"'experimental_fastapi_users_template' param must be in {truthy + falsy}")
 
     copy_choosen_template_to_main_dir(used_template=used_template)
     create_env_file_and_remove_env_template()

hooks/post_gen_project.py

@@ -15,7 +15,7 @@ def main():
         no_input=True,
         extra_context={
             "project_name": "fastapi_users_project",
-            "use_fastapi_users": True,
+            "experimental_fastapi_users_template": True,
         },
     )
 

tests/create_fastapi_users_project.py

@@ -15,7 +15,7 @@ def main():
         no_input=True,
         extra_context={
             "project_name": "minimal_project",
-            "use_fastapi_users": False,
+            "experimental_fastapi_users_template": False,
         },
     )