Merge pull request #159 from TTWShell/release/4.0.0

Release/4.0.0

Author: TTWShell

README.md

@@ -31,7 +31,47 @@ pipenv install -r requirements.txt --pre && pipenv install --dev pytest pytest-c
 pipenv shell
 ```
 
-## Run server:
+## flask cli:
+
+```
+(demo) ➜  FLASK_APP=app.run:app flask
+Usage: flask [OPTIONS] COMMAND [ARGS]...
+
+  A general utility script for Flask applications.
+
+  An application to load must be given with the '--app' option, 'FLASK_APP'
+  environment variable, or with a 'wsgi.py' or 'app.py' file in the current
+  directory.
+
+Options:
+  -e, --env-file FILE   Load environment variables from this file. python-
+                        dotenv must be installed.
+  -A, --app IMPORT      The Flask application or factory function to load, in
+                        the form 'module:name'. Module can be a dotted import
+                        or file path. Name is not required if it is 'app',
+                        'application', 'create_app', or 'make_app', and can be
+                        'name(args)' to pass arguments.
+  --debug / --no-debug  Set debug mode.
+  --version             Show the Flask version.
+  --help                Show this message and exit.
+
+Commands:
+  db      Perform database migrations.
+  routes  Show the routes for the app.
+  run     Run a development server.
+  shell   Runs a shell in the app context.
+```
+
+```
+(demo) ➜  FLASK_APP=app.run:app flask routes
+Endpoint      Methods  Rule
+------------  -------  -----------------------
+static        GET      /static/<path:filename>
+tools.option  GET      /api/options
+tools.ping    GET      /api/ping
+```
+
+## Run server
 
 ```
 (demo) ➜  flask -A app/run.py run
@@ -41,6 +81,13 @@ WARNING: This is a development server. Do not use it in a production deployment.
     * Running on http://127.0.0.1:5000
 ```
 
+```
+➜  ~ curl http://127.0.0.1:5000/api/ping
+{"ping":"ok"}
+➜  ~ curl http://127.0.0.1:5000/api/options
+{}
+```
+
 ## Run test:
 
 ```
@@ -92,4 +139,10 @@ TOTAL                          126      6    95%
 
 ```
 hobbit --help
+```
+
+# dev
+
+```
+pip install "hobbit-core[hobbit,hobbit_core]=={version}" --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/
 ```

hobbit/__init__.py

@@ -95,7 +95,7 @@ def format_commands(self, ctx, formatter):
     cls=HobbitGroup,
     epilog='More details: https://hobbit-core.readthedocs.io/zh/latest/',
     context_settings=CONTEXT_SETTINGS)
-@click.version_option()
+@click.version_option(package_name='hobbit_core')
 @click.option('--echo/--no-echo', default=False,
               help='Show the logs of command.')
 @click.pass_context

setup.py

@@ -32,7 +32,7 @@ def gen_data(data_root='static'):
 
 setup(
     name='hobbit-core',
-    version='4.0.0rc0',
+    version='4.0.0',
     python_requires='>=3.8, <4',
     description='Hobbit - A flask project generator.',
     long_description=long_description,
@@ -78,6 +78,6 @@ def gen_data(data_root='static'):
         ],
     },
     entry_points={
-        'console_scripts': 'hobbit = hobbit:main [hobbit]'
+        'console_scripts': 'hobbit=hobbit:main'
     },
 )