- Added generate_local_key to init command in CLI

- Added publish_locally option to publish command in CLI
- Added local_user option in create_admin_user CLI command
- Updated the version number to 0.5.5
- Updated key features in README.md

Author: bjinwright

README.md

@@ -11,6 +11,7 @@ Includes GraphQL and generic ABAC auth workflow integrations.
 - Create a GraphQL endpoint and a schema validating ORM with the same code.
 - Authentication collections, indexes, user-defined functions, and roles included.
 - Generic CRUD user-defined functions included
+- Create a REST API to integrate Fauna and Non-Fauna related tasks
 - Schema validation based on the [Valley](https://github.com/capless/valley) library.
 
 ## Full Documentation

pfunk/cli.py

@@ -2,12 +2,15 @@
 import json
 import os
 import sys
+import datetime
 
 from jinja2 import TemplateNotFound
 from valley.utils import import_util
 from werkzeug.serving import run_simple
+from pfunk.client import FaunaClient, q
 
 from pfunk.contrib.auth.collections import Group, PermissionGroup
+from pfunk.exceptions import DocNotFound
 from pfunk.template import wsgi_template, project_template, collections_templates, key_template
 from pfunk.utils.deploy import Deploy
 
@@ -23,13 +26,15 @@ def load_config_file(filename):
     return config
 
 @pfunk.command()
+@click.option('--generate_local_key', prompt=True, help='Specifies whether to generate a local database and key',
+              default=False)
 @click.option('--stage_name', prompt=True, help='Application stage', default='dev')
 @click.option('--email', prompt=True, help='Default From Email')
 @click.option('--bucket', prompt=True, help='S3 Bucket')
 @click.option('--fauna_key', prompt=True, help='Fauna Key')
 @click.option('--api_type', type=click.Choice(['web', 'rest', 'none']), prompt=True, help='API Type (web, rest, none)')
 @click.argument('name')
-def init(name: str, api_type: str, fauna_key: str, bucket: str, email: str, stage_name: str):
+def init(name: str, api_type: str, fauna_key: str, bucket: str, email: str, stage_name: str, generate_local_key: bool):
     """
     Creates a PFunk project
     Args:
@@ -64,6 +69,17 @@ def init(name: str, api_type: str, fauna_key: str, bucket: str, email: str, stag
             f.write(project_template.render())
         with open(f'{name}/collections.py', 'x') as f:
             f.write(collections_templates.render())
+        if generate_local_key:
+            client = FaunaClient(secret='secret')
+            db_name = f'{name}-local'
+            client.query(
+                q.create_database({'name': db_name})
+            )
+            key = client.query(
+                q.create_key({'database': q.database(db_name), 'role': 'admin'})
+            )
+            click.secho(f'Fauna Local Secret (copy into your .env or pipenv file): {key}', fg='green')
+
     else:
         click.echo('There is already a project file in this directory.')
 
@@ -121,10 +137,11 @@ def local(hostname: str, port: int, wsgi: str, config_file: str, use_debugger: b
 
 
 @pfunk.command()
+@click.option('--publish_locally', prompt=True, help='Specifies whether to publish the schema locally.', default=False)
 @click.option('--config_path', help='Configuration file path', default='pfunk.json')
 @click.option('--project_path', help='Project module path')
 @click.argument('stage_name')
-def publish(stage_name: str, project_path: str, config_path: str):
+def publish(stage_name: str, project_path: str, config_path: str, publish_locally: bool):
     """
     Publish GraphQL schema to Fauna
     Args:
@@ -140,8 +157,10 @@ def publish(stage_name: str, project_path: str, config_path: str):
     if not project_path:
         project_path = f'{config.get("name")}.project.project'
     project = import_util(project_path)
-    secret = config['stages'][stage_name]['fauna_secret']
-    os.environ['FAUNA_SECRET'] = secret
+    if not publish_locally:
+
+        secret = config['stages'][stage_name]['fauna_secret']
+        os.environ['FAUNA_SECRET'] = secret
     project.publish()
 
 
@@ -168,6 +187,7 @@ def seed_keys(stage_name: str, config_path: str):
     return keys_path
 
 @pfunk.command()
+@click.option('--local_user', help='Specifies whether the user is local.', prompt=True, default=False)
 @click.option('--config_path', help='Configuration file path', default='pfunk.json')
 @click.option('--project_path', help='Project module path')
 @click.option('--username', prompt=True, help='Username')
@@ -178,7 +198,7 @@ def seed_keys(stage_name: str, config_path: str):
 @click.option('--group_slug', prompt=True, help='User Group Slug', default=None)
 @click.argument('stage_name')
 def create_admin_user(stage_name: str, group_slug: str, last_name: str, first_name: str, email: str, password: str, username: str,
-                      project_path: str, config_path: str):
+                      project_path: str, config_path: str, local_user: bool):
     """
     Create an admin user in the project's Fauna user collection.
     Args:
@@ -191,14 +211,16 @@ def create_admin_user(stage_name: str, group_slug: str, last_name: str, first_na
         username: Username for the user
         project_path: Project path
         config_path: Config path
+        local_user: Specifies whether to create the user locally.
 
     Returns:
 
     """
     config = load_config_file(config_path)
     secret = config['stages'][stage_name]['fauna_secret']
     User = import_util('pfunk.contrib.auth.collections.User')
-    os.environ['FAUNA_SECRET'] = secret
+    if not local_user:
+        os.environ['FAUNA_SECRET'] = secret
 
     user = User.create(
         username=username,
@@ -210,7 +232,10 @@ def create_admin_user(stage_name: str, group_slug: str, last_name: str, first_na
     )
 
     if group_slug:
-        group = Group.get_by('unique_Group_slug', group_slug)
+        try:
+            group = Group.get_by('unique_Group_slug', group_slug)
+        except DocNotFound:
+            group = Group.create(name=group_slug, slug=group_slug)
         if not project_path:
             project_path = f'{config.get("name")}.project.project'
         sys.path.insert(0, os.getcwd())

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pfunk"
-version = "0.5.0"
+version = "0.5.5"
 description = "A Python library created make building FaunaDB GraphQL schemas and authentication code easier."
 authors = ["Brian Jinwright"]
 license = "Apache-2.0"