[pull] master from gleitz:master

.gitattributes

@@ -1,2 +1,3 @@
 cache_html/* linguist-vendored
 *.html linguist-language=Python
+*.ipynb linguist-documentation

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,16 @@
+---
+name: Bug Report
+about: Report a bug encountered with howdoi
+labels: bug
+---
+
+#### What happened:
+
+#### What you expected to happen:
+
+#### Output with `--explain`
+Please provide the output of running the same command with the `--explain` flag like so
+
+```
+$ howdoi YOUR_COMMAND --explain
+```

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,16 @@
+---
+name: Documentation
+about: If your issue is related to creating new or fixing the existing documentation.
+title: ''
+labels: ''
+assignees: joeyouss
+
+---
+
+### Description 
+(Describe in detail what you want to work on)
+
+### Additional Comments (if any)
+### Have you read the [Contributing Guidelines on Pull Requests]?
+
+(Write your answer here.)

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,16 @@
+---
+name: Feature
+about: If your issue suggests/proposes new features which improve howdoi
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Description 
+(Describe in detail what you want to work on)
+
+### Additional Comments (if any)
+### Have you read the Contributing Guidelines on Pull Requests on mkdocs?
+
+(Write your answer here.)

.github/ISSUE_TEMPLATE/help-and-asking-questions.md

@@ -0,0 +1,19 @@
+---
+name: Help and asking questions
+about: If you are stuck and want to ask the howdoi maintainers for help
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Description 
+(Describe in detail what you are working on)
+
+### Help wanted for
+(Describe what help you need and what are the problems you are facing currently)
+
+### Additional Comments (if any)
+### Have you read the Contributing Guidelines on Pull Requests on mkdocs?
+
+(Write your answer here.)

.github/ISSUE_TEMPLATE/miscellaneous.md

@@ -0,0 +1,16 @@
+---
+name: Miscellaneous
+about: If your issue does not fit in other listed categories.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Description 
+(Describe in detail what your issue is related to)
+
+### Additional Comments (if any)
+### Have you read the Contributing Guidelines on Pull Requests on mkdocs?
+
+(Write your answer here.)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,33 @@
+## Description:
+
+- Tasks solved
+
+- Links to issues solved
+
+## Pull Request type:
+
+- Bug fixes
+- New feature
+- Improvement
+- Refactoring
+- Documentation update
+- Security fix
+
+## How to test:
+
+Please provide detailed instructions for testing your changes locally, including expected response/behavior.
+
+## Pull Request checklist:
+
+- [ ] Read the [contributing_to_howdoi.md](https://github.com/gleitz/howdoi/blob/master/docs/contributing_to_howdoi.md)
+- [ ] Attach screenshots of expected behavior.
+- [ ] The changes pass tests locally (`nose2`).
+- [ ] There are no linting errors (`python setup.py lint`).
+- [ ] The changes don't break existing features.
+- [ ] Check that there are no confidential files like `.env` included.
+- [ ] Request review from the maintainers.
+- [ ] For bug fixes or changes to directory structure, make sure docs are updated.
+
+## Known bugs (if any):
+
+If there are bugs in your current changes you can still open the PR and mention the bugs you found. Propose further changes that can help fix bugs in your current changes.

.github/workflows/docs.yml

@@ -14,6 +14,8 @@ jobs:
 
     - name: Set up Python
       uses: actions/setup-python@v2
+      with:
+        python-version: '3.11'
 
     - name: Install Pip
       run:  python -m pip install --upgrade pip

.github/workflows/early-warning.yml

@@ -15,6 +15,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
+        with:
+          python-version: '3.11'
 
       - name: Setup environment
         run: pip install -r requirements.txt

.github/workflows/python-non-master.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9, '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v2
@@ -27,8 +27,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 nose pylint
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements/dev.txt ]; then pip install -r requirements/dev.txt; fi
     - name: Lint with flake8
       run: |
         flake8 . --count --show-source --statistics
@@ -37,4 +36,4 @@ jobs:
         pylint howdoi *.py --rcfile=.pylintrc
     - name: Test with nose
       run: |
-        nosetests
+        nose2

.github/workflows/python.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8, 3.9, '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v2
@@ -23,8 +23,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 nose pylint
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements/dev.txt ]; then pip install -r requirements/dev.txt; fi
     - name: Lint with flake8
       run: |
         flake8 . --count --show-source --statistics
@@ -33,4 +32,4 @@ jobs:
         pylint howdoi *.py --rcfile=.pylintrc
     - name: Test with nose
       run: |
-        nosetests
+        nose2

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+      - id: flake8
+        args:
+          - "--config=.flake8rc"
+
+  - repo: https://github.com/PyCQA/pylint/
+    rev: v2.15.10
+    hooks:
+      - id: pylint
+        args:
+          - "howdoi *.py --rcfile=.pylintrc"

.pylintrc

@@ -244,13 +244,6 @@ max-line-length=119
 # Maximum number of lines in a module.
 max-module-lines=1000
 
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
-
 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no

CHANGES.txt

@@ -1,3 +1,28 @@
+2.0.20
+------
+-  Update dependency versions
+-  Add support for Python 3.10
+
+2.0.19
+------
+-  Fix typo
+
+2.0.18
+------
+-  Fixed issue with howdoi cache where cache misses would be printed to the console
+
+2.0.17
+------
+-  New documentation and mkdocs
+-  Fixed issue with how howdoi chooses the proper search engine (command line flags now override environment variables)
+-  Added a search engine fallback if one of the search engines fails
+-  Fixed issue with howdoi cache
+
+2.0.16
+------
+-  Fix GDPR issue for those using howdoi in countries outside the US
+-  Better support for using `HOWDOI_URL`
+
 2.0.15
 ------
 -  Add explainability with `-x` or `--explain` options

MANIFEST.in

@@ -1,9 +1,10 @@
 include LICENSE.txt
-include README.rst
+include README.md
 include CHANGES.txt
 include fastentrypoints.py
 include requirements.txt
 include test_howdoi.py
 exclude howdoi.rb
 exclude .*rc
 prune page_cache
+prune notebooks