Merge pull request #41 from ryancheley/v0.9.0

V0.9.0

.coveragerc

@@ -6,4 +6,4 @@ omit=
 [report]
 fail_under = 100
 show_missing = True
-skip_covered = False
+skip_covered = False

.github/pull_request_template.md

@@ -30,4 +30,4 @@ Issue Number: N/A
 
 ## Other information
 
-<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->

.github/workflows/publish.yml

@@ -55,4 +55,3 @@ jobs:
       run: |
         python -m build
         twine upload dist/*
-

.github/workflows/test.yml

@@ -35,4 +35,3 @@ jobs:
     - name: Run tests
       run: |
         pytest
-

.gitignore

@@ -13,4 +13,4 @@ dist
 
 # ignore the output files generated
 output.html
-output.txt
+output.txt

.pre-commit-config.yaml

@@ -17,4 +17,11 @@ repos:
     hooks:
       - id: isort
         args: ["--profile", "black"]
-        name: isort (python)
+        name: isort (python)
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files

CODE_OF_CONDUCT.md

@@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

README.md

@@ -29,54 +29,50 @@ Run this command and paste in your new token:
 
 This will create a file called auth.json in your current directory containing the required value. To save the file at a different path or filename, use the `--auth=myauth.json` option.
 
-## Usage
-
-    Usage: the-well-maintained-test [OPTIONS] COMMAND [ARGS]...
-
-    Programatically tries to answer the 12 questions from Adam Johnson's blog
-    post https://adamj.eu/tech/2021/11/04/the-well-maintained-test/ URL is a url
-    to a github repository you'd like to check, for example:
-
-        the-well-maintained-test url 'https://github.com/ryancheley/the-well-
-        maintained-test'
-
-    package is a package on pypi you'd like to check:
-
-        the-well-maintained-test package --name the-well-maintained-test
-
-    Note: URL is being deprecated and replaced with package starting in v0.9.0
-
-    Options:
-    --version  Show the version and exit.
-    --help     Show this message and exit.
-
-    Commands:
-    auth          Save authentication credentials to a JSON file
-    check         Check your GitHub API Usage Stats.
-    package       Name of a package on PyPi you'd like to check
-    questions     List of questions tested
-    requirements  Loop over a requirements.txt file
-    url           URL to a github repository you'd like to check.
-
-If you want to see what questions will be answered before running you you can pass 
-
-    the-well-maintained-test questions
-
-If you want to see a single question and the original source from Adam Johnson's blog
-
-    the-well-maintained-test questions -q 3
-
-
-    3. Is there a changelog?
-
-        A changelog, or a release notes page, is vital for our ability to update the package. The changelog is the main place for communication of breaking changes. (A case for changelogs is made at keepachangelog.com.)
-
-        Changelogs come in many forms: a single file, a documentation section, GitHub release descriptions, etc. Again, hopefully the package doesn’t make you hunt for it. 
-
-        Note that some projects “have a changelog”, but it has stopped being maintained since the project’s inception. So check that the changelog covers recent releases.
-
-    See https://adamj.eu/tech/2021/11/04/the-well-maintained-test/#is-there-a-changelog for the original source.
-
+## the-well-maintained-test --help
+
+<!-- [[[cog
+import cog
+from the_well_maintained_test import cli
+from click.testing import CliRunner
+runner = CliRunner()
+result = runner.invoke(cli.cli, ["--help"])
+help = result.output.replace("Usage: cli", "Usage: the-well-maintained-test")
+cog.out(
+    "```\n{}\n```".format(help)
+)
+]]] -->
+```
+Usage: the-well-maintained-test [OPTIONS] COMMAND [ARGS]...
+
+  Programatically tries to answer the 12 questions from Adam Johnson's blog post
+  https://adamj.eu/tech/2021/11/04/the-well-maintained-test/
+
+  package is a package on pypi you'd like to check:
+
+      the-well-maintained-test package the-well-maintained-test
+
+  URL is a url to a github repository you'd like to check, for example:
+
+      the-well-maintained-test url 'https://github.com/ryancheley/the-well-
+      maintained-test'
+
+  Note: URL was deprecated and replaced with package starting in v0.9.0
+
+Options:
+  --version  Show the version and exit.
+  --help     Show this message and exit.
+
+Commands:
+  auth          Generates a json file with your GitHub Personal Token so...
+  check         Check your GitHub API Usage Stats
+  package       Name of a package on PyPi you'd like to check
+  questions     List of questions tested
+  requirements  Loop over a requirements.txt file
+  url           URL to a github repository you'd like to check.
+
+```
+<!-- [[[end]]] -->
 
 ## Development
 

contributing.md

@@ -18,9 +18,9 @@ To run the tests:
 
 ## Code style
 
-This library uses 
+This library uses
 
-* [Black](https://github.com/psf/black) and [Flake8](https://github.com/PyCQA/flake8) for code formatting. 
+* [Black](https://github.com/psf/black) and [Flake8](https://github.com/PyCQA/flake8) for code formatting.
 * [isort](https://github.com/PyCQA/isort) to sort packages
 
-The correct version of these libraries will be installed by `pip install -e '.[test]'` - you can run `pre-commit run --all-files` in the root directory to apply those formatting rules.
+The correct version of these libraries will be installed by `pip install -e '.[test]'` - you can run `pre-commit run --all-files` in the root directory to apply those formatting rules.

example_auth.json

@@ -1,3 +1,3 @@
 {
     "github_personal_token": "github_personal_token goes here"
-}
+}

justfile

@@ -1,6 +1,6 @@
 # run tests via pytest, creates coverage report, and then opens it up
 test:
-    coverage run -m pytest 
+    coverage run -m pytest
     coverage html --omit=src/the_well_maintained_test/cli.py--omit=src/the_well_maintained_test/cli.py
     open htmlcov/index.html
 
@@ -22,5 +22,10 @@ gitclean:
 
 
 # run mypy on the files
-mypy: 
-    mypy src/the_well_maintained_test/*.py --no-strict-optional
+mypy:
+    mypy src/the_well_maintained_test/*.py --no-strict-optional
+
+
+# generates the README.md file --help section
+cog:
+    cog -r README.md

pyproject.toml

@@ -2,4 +2,4 @@
 line-length = 130
 target-version = ['py39']
 include = '\.pyi?$'
-exclude = '(venv)'
+exclude = '(venv)'

setup.cfg

@@ -1,4 +1,4 @@
 [flake8]
 exclude = .git,*migrations*,*venv*
 max-line-length = 130
-ignore = E203
+ignore = E203

setup.py

@@ -2,7 +2,7 @@
 
 from setuptools import setup
 
-VERSION = "0.8.1"
+VERSION = "0.9.0"
 
 
 def get_long_description():
@@ -37,7 +37,7 @@ def get_long_description():
     """,
     package_data={"the_well_maintained_test": ["data/question*"]},
     install_requires=["click", "requests", "rich", "toml"],
-    extras_require={"test": ["pytest", "black", "isort", "coverage", "mypy"]},
+    extras_require={"test": ["pytest", "black", "isort", "coverage", "mypy", "cogapp"]},
     python_requires=">=3.7",
     classifiers=[
         "Development Status :: 4 - Beta",