Merge pull request #24 from PFython/pf-dev

Version 1.18

.gitignore

@@ -128,3 +128,4 @@ dmypy.json
 
 
 *.pptx
+*old.py

LICENSE - old.py

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Peter Fison
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -55,6 +55,11 @@ Thanks to the magic of [`cleverdict`](https://github.com/pfython/cleverdict) you
 
 Your last set of answers (except passwords) are stored in a JSON config file will be kept up to date automatically when you change values.  The location defaults to the recommended setting folder for your Operating System.
 
+If you want to create a `Package` object but skip the default review of metadata and return early to the command line, you can use the `prompts` keyword argument:
+
+    >>> package = Package("as_easy_as_pie", prompts=False)
+
+
 # 3. THE FOUR STEP PROCESS
 
 Apart from the obvious `__init__` when you create your `Package`, there are four main methods or 'entry points' which you can invoke directly to step through the publishing process:
@@ -98,6 +103,10 @@ This entry point also includes a handy option to auto-create a new (private) Git
 
 # 4. OTHER FEATURES
 
+Check which essential values haven't yet been set:
+
+    >>> package.summary()
+
 Automatically generate the next version number for your `Package` (more schemas coming soon):
 
     >>> package.version = "1.1"
@@ -111,11 +120,6 @@ When you use the `.review()` method `easyPyPI` will helpfully update the current
 
     # Resets to False after going through the .review process
 
-If you want to create an `Package` object but skip the review of metadata and return early to the command line, you can just supply "False" as the 2nd argument:
-
-    >>> package = Package("as_easy_as_pie, False)
-    # You'll still be prompted for a directory in order to search for setup.py
-
 To find where easyPyPI and its default templates were installed:
 
     >>> package.easypypi_dirpath