Merge pull request #8 from bitranox/development

v1.0.6
bitranox · Aug 14, 2020 · 6c459da · 6c459da
2 parents 66eef2a + 6e06fb7
commit 6c459da
Show file tree

Hide file tree

Showing 15 changed files with 213 additions and 243 deletions.
diff --git a/.docs/README_template.rst b/.docs/README_template.rst
@@ -2,7 +2,7 @@ igittigitt
 ==========
 
 
-Version v1.0.5 as of 2020-08-14 see `Changelog`_
+Version v1.0.6 as of 2020-08-14 see `Changelog`_
 
 
 .. include:: ./badges.rst

diff --git a/.docs/badges.rst b/.docs/badges.rst
@@ -1,4 +1,4 @@
-|travis_build| |license| |jupyter| |pypi|
+|travis_build| |license| |jupyter| |pypi| |black|
 
 |codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
 
@@ -36,3 +36,6 @@
 
 .. |snyk| image:: https://img.shields.io/snyk/vulnerabilities/github/bitranox/igittigitt
    :target: https://snyk.io/test/github/bitranox/igittigitt
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
diff --git a/.docs/tested_under.rst b/.docs/tested_under.rst
@@ -1,3 +1,3 @@
 tested on linux "bionic" with python 3.6, 3.7, 3.8, 3.8-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64
 
-`100% code coverage <https://codecov.io/gh/bitranox/igittigitt>`_, flake8 style checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/igittigitt>`_, automatic daily builds and monitoring
+`100% code coverage <https://codecov.io/gh/bitranox/igittigitt>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/igittigitt>`_, automatic daily builds and monitoring
diff --git a/.travis.yml b/.travis.yml
@@ -21,7 +21,7 @@ env:
         - DO_FLAKE8_TESTS="True"
 
         # MYPY tests
-        - MYPY_DO_TESTS="False"
+        - MYPY_DO_TESTS="True"
         - MYPY_OPTIONS="--follow-imports=normal --implicit-reexport --no-warn-unused-ignores --strict"
         - MYPYPATH="./igittigitt/3rd_party_stubs"
 
@@ -76,7 +76,7 @@ matrix:
           - export DEPLOY_SDIST="False"
           - export DEPLOY_WHEEL="False"
           - export DEPLOY_TEST="False"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
 
     - os: linux
@@ -89,7 +89,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="True"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: linux
       arch: "amd64"
@@ -101,7 +101,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="False"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: linux
       arch: "amd64"
@@ -113,7 +113,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="True"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: linux
       arch: "amd64"
@@ -125,7 +125,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="True"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: linux
       arch: "amd64"
@@ -149,7 +149,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="True"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: linux
       arch: "s390x"
@@ -161,7 +161,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="True"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: linux
       arch: "arm64"
@@ -173,7 +173,7 @@ matrix:
           - export DEPLOY_SDIST="True"
           - export DEPLOY_WHEEL="True"
           - export BUILD_TEST="True"
-          - export MYPY_DO_TESTS="False"
+          - export MYPY_DO_TESTS="True"
 
     - os: osx
       if: true
@@ -190,7 +190,7 @@ matrix:
         - export DEPLOY_SDIST="False"
         - export DEPLOY_WHEEL="False"
         - export DEPLOY_TEST="True"
-        - export MYPY_DO_TESTS="False"
+        - export MYPY_DO_TESTS="True"
 
 
 install:

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -7,11 +7,16 @@ Changelog
 
 TODO:
     - code coverage
-    - test context manager
     - add nested .gitignore files
-    - __ALL__= ...
     - documentation
-    - asserts for __ALL__ parameters
+
+v1.0.6
+--------
+2020-08-14:
+    - get rid of the named tuple
+    - implement attrs
+    - full typing, PEP561 package
+    - add blacked badge
 
 v1.0.5
 --------

diff --git a/README.rst b/README.rst
@@ -2,9 +2,9 @@ igittigitt
 ==========
 
 
-Version v1.0.5 as of 2020-08-14 see `Changelog`_
+Version v1.0.6 as of 2020-08-14 see `Changelog`_
 
-|travis_build| |license| |jupyter| |pypi|
+|travis_build| |license| |jupyter| |pypi| |black|
 
 |codecov| |better_code| |cc_maintain| |cc_issues| |cc_coverage| |snyk|
 
@@ -43,6 +43,9 @@ Version v1.0.5 as of 2020-08-14 see `Changelog`_
 .. |snyk| image:: https://img.shields.io/snyk/vulnerabilities/github/bitranox/igittigitt
    :target: https://snyk.io/test/github/bitranox/igittigitt
 
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
 A spec-compliant gitignore parser for Python
 
 forked from https://github.com/mherrmann/gitignore_parser we might join later ....
@@ -102,7 +105,7 @@ Python version required: 3.6.0 or newer
 
 tested on linux "bionic" with python 3.6, 3.7, 3.8, 3.8-dev, pypy3 - architectures: amd64, ppc64le, s390x, arm64
 
-`100% code coverage <https://codecov.io/gh/bitranox/igittigitt>`_, flake8 style checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/igittigitt>`_, automatic daily builds and monitoring
+`100% code coverage <https://codecov.io/gh/bitranox/igittigitt>`_, flake8 style checking ,mypy static type checking ,tested under `Linux, macOS, Windows <https://travis-ci.org/bitranox/igittigitt>`_, automatic daily builds and monitoring
 
 ----
 
@@ -135,7 +138,7 @@ Usage
 .. code-block:: python
 
     class IgnoreParser(object):
-        def __init__(self):
+        def __init__(self) -> None:
             """
             init the igittigitt parser.
             """
@@ -156,7 +159,7 @@ Usage
 
 .. code-block:: python
 
-        def add_rule(self, pattern: str, base_path: PathLikeOrString):
+        def add_rule(self, pattern: str, base_path: PathLikeOrString) -> None:
             """
             add a rule as a string
 
@@ -269,6 +272,7 @@ following modules will be automatically installed :
 .. code-block:: bash
 
     ## Project Requirements
+    attrs
     click
     cli_exit_tools @ git+https://github.com/bitranox/cli_exit_tools.git
 
@@ -299,11 +303,16 @@ Changelog
 
 TODO:
     - code coverage
-    - test context manager
     - add nested .gitignore files
-    - __ALL__= ...
     - documentation
-    - asserts for __ALL__ parameters
+
+v1.0.6
+--------
+2020-08-14:
+    - get rid of the named tuple
+    - implement attrs
+    - full typing, PEP561 package
+    - add blacked badge
 
 v1.0.5
 --------

diff --git a/igittigitt/__init__conf__.py b/igittigitt/__init__conf__.py
@@ -1,20 +1,22 @@
-name = 'igittigitt'
-title = 'A spec-compliant gitignore parser for Python'
-version = 'v1.0.5'
-url = 'https://github.com/bitranox/igittigitt'
-author = 'Robert Nowotny'
-author_email = '[email protected]'
-shell_command = 'igittigitt'
+name = "igittigitt"
+title = "A spec-compliant gitignore parser for Python"
+version = "v1.0.6"
+url = "https://github.com/bitranox/igittigitt"
+author = "Robert Nowotny"
+author_email = "[email protected]"
+shell_command = "igittigitt"
 
 
 def print_info() -> None:
-    print("""\
+    print(
+        """\
 
 Info for igittigitt:
 
     A spec-compliant gitignore parser for Python
 
-    Version : v1.0.5
+    Version : v1.0.6
     Url     : https://github.com/bitranox/igittigitt
     Author  : Robert Nowotny
-    Email   : [email protected]""")
+    Email   : [email protected]"""
+    )