fix README and move mypy/pytest to pyproject.toml

Author: nullhack

cookiecutter.json

@@ -6,7 +6,7 @@
   "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
   "package_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_').replace('project', 'package') }}",
   "module_name": "{{ cookiecutter.package_name.lower().replace(' ', '_').replace('-', '_').replace('package', 'module') }}",
-  "project_short_description": "Python Project with some awesome tools to quickstart any Python project.",
+  "project_short_description": "Python template with some awesome tools to quickstart any Python project.",
   "version": "0.1.0",
-  "license": ["MIT", "BSD-3-Clause", "Apache-2.0", "GPL-3.0", "Proprietary"]
+  "license": ["MIT", "BSD_3_Clause", "Apache_2.0", "GPL_3.0", "Proprietary"]
 }

{{cookiecutter.project_slug}}/.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     -   id: detect-aws-credentials
     -   id: detect-private-key
     -   id: end-of-file-fixer
-        exclude: ^docs/
+        files: .*\.py
     -   id: mixed-line-ending
     -   id: name-tests-test
 -   repo: https://github.com/PyCQA/isort
@@ -24,8 +24,6 @@ repos:
     rev: v0.942
     hooks:
         - id: mypy
-          additional_dependencies: [pydantic]
-          exclude: noxfile.py
 -   repo: local
     hooks:
     -   id: black-formatter

{{cookiecutter.project_slug}}/LICENSE.txt

@@ -20,7 +20,7 @@ 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.
-{% elif cookiecutter.license == 'BSD-3-Clause' %}
+{% elif cookiecutter.license == 'BSD_3_Clause' %}
 
 BSD License
 
@@ -51,7 +51,7 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 OF THE POSSIBILITY OF SUCH DAMAGE.
-{% elif cookiecutter.license == 'Apache-2.0' -%}
+{% elif cookiecutter.license == 'Apache_2.0' -%}
 Apache Software License 2.0
 
 Copyright (c) {% now 'local', '%Y' %}, {{ cookiecutter.full_name }}
@@ -67,7 +67,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-{% elif cookiecutter.license == 'GPL-3.0' -%}
+{% elif cookiecutter.license == 'GPL_3.0' -%}
 GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007
 
@@ -100,6 +100,6 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
-{% elif cookiecutter.license == 'BSD-3-Clause' %}
+{% elif cookiecutter.license == 'Proprietary' %}
     Copyright (C) {% now 'local', '%Y' %}  {{ cookiecutter.full_name }} all rights reserved
 {% endif %}

{{cookiecutter.project_slug}}/README.md

@@ -77,16 +77,16 @@
 
 #### Packages
 
-  <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_new_package.png">
-    <img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_new_package.png" alt="uml-diagram-packages">
+  <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_{{cookiecutter.package_name}}.png">
+    <img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/packages_{{cookiecutter.package_name}}.png" alt="uml-diagram-packages">
   </a>
 
 ---
 
 #### Classes
 
-  <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_new_package.png">
-    <img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_new_package.png" alt="uml-diagram-classes">
+  <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png">
+    <img src="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/raw/main/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png" alt="uml-diagram-classes">
   </a>
 
 <p align="right">(<a href="#top">back to top</a>)</p>
@@ -195,7 +195,7 @@ Don't forget to give the project a star! Thanks again!
 <!-- LICENSE -->
 ## License
 
-Distributed under the {{cookiecutter.license}} License. See [`LICENSE.txt`](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/LICENSE.txt) for more information.
+Distributed under the {{cookiecutter.license}} License. See [`LICENSE.txt`](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/blob/master/LICENSE.txt) for more information.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -239,6 +239,6 @@ References and sources of inspiration
 [stars-url]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/stargazers
 [issues-shield]: https://img.shields.io/github/issues/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.svg?style=for-the-badge
 [issues-url]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues
-[license-shield]: https://img.shields.io/github/license/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}.svg?style=for-the-badge
+[license-shield]: https://img.shields.io/badge/license-{{cookiecutter.license}}-green?style=for-the-badge
 [license-url]: https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/blob/master/LICENSE.txt
 

{{cookiecutter.project_slug}}/docs/uml/artifacts/classes_{{cookiecutter.package_name}}.dot

@@ -1,5 +1,5 @@
-digraph "classes_new_package" {
+digraph "classes_my_python_package" {
 rankdir=BT
 charset="utf-8"
-"new_package.new_module.Calculator" [color="black", fontcolor="black", label="{new_package.new_module.Calculator|\l|divide(a: Real, b: Real): Real\l}", shape="record", style="solid"];
+"my_python_package.my_python_module.Calculator" [color="black", fontcolor="black", label="{my_python_package.my_python_module.Calculator|\l|divide(a: Real, b: Real): Real\l}", shape="record", style="solid"];
 }

{{cookiecutter.project_slug}}/docs/uml/artifacts/packages_{{cookiecutter.package_name}}.dot

@@ -1,6 +1,6 @@
-digraph "packages_new_package" {
+digraph "packages_my_python_package" {
 rankdir=BT
 charset="utf-8"
-"new_package" [color="black", label="new_package", shape="box", style="solid"];
-"new_package.new_module" [color="black", label="new_package.new_module", shape="box", style="solid"];
+"my_python_package" [color="black", label="my_python_package", shape="box", style="solid"];
+"my_python_package.my_python_module" [color="black", label="my_python_package.my_python_module", shape="box", style="solid"];
 }

{{cookiecutter.project_slug}}/docs/uml/diagrams/classes_{{cookiecutter.package_name}}.png

@@ -8,7 +8,7 @@ authors = ["{{cookiecutter.full_name}} <{{cookiecutter.email}}>"]
 python = "^3.9"
 
 [tool.poetry.dev-dependencies]
-pytest = "^5.2"
+pytest = "7.1.1"
 pytest-cov = "^3.0.0"
 pre-commit = "^2.18.1"
 flake8 = "^4.0.1"
@@ -68,3 +68,32 @@ exclude = '''
                      # the root of the project
 )
 '''
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--verbose --color=yes --cov=src --cov-fail-under=100 --cov-report term-missing --doctest-modules"
+testpaths = [
+    "tests",
+    "src"
+]
+python_files = ["*_test.py"]
+python_functions = ["test_*"]
+render_collapsed = true
+
+[tool.mypy]
+warn_return_any = false
+warn_unused_configs = true
+warn_redundant_casts = true
+
+[[tool.mypy.overrides]]
+module = [
+    "{{cookiecutter.package_name}}"
+]
+follow_imports = "silent"
+strict_optional = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+disallow_untyped_defs = true
+ignore_missing_imports = true