More cleanup and update README

Fix linting issue, remove some unnecessary lines in CI and setup.cfg

Author: holybiber

.github/workflows/main.yml

@@ -31,10 +31,6 @@ jobs:
       - name: Run all tests
         run: python -X dev -m unittest discover -s pywikitools/test
 
-      # Now we're generating the coverage report
-      - name: Install coverage.py
-        run: pip install coverage
-
       - name: Generate coverage report
         run: |
           coverage run --source=pywikitools/,pywikitools/correctbot/ --omit=pywikitools/user-config.py -m unittest discover -s pywikitools/test

CONTRIBUTING.md

@@ -52,8 +52,8 @@ Ready to contribute? Here's how to set up `pywikitools` for local development.
    `flake8` has nothing to complain:
 
    ```shell
-   $ python3 -m unittest discover -s pywikitools/test
-   $ flake8 .
+   $ make test
+   $ make lint
    ```
 
 6. Commit your changes and push your branch to GitHub:

README.md

@@ -29,7 +29,6 @@ use the [pywikibot framework](https://www.mediawiki.org/wiki/Manual:Pywikibot).
   * [License](#license)
   * [Contributing and coding conventions](#contributing-and-coding-conventions)
   * [Communication](#communication)
-  * [Credits](#credits)
 <!-- TOC -->
 
 ## Setup
@@ -94,22 +93,23 @@ stored in `pywikibot-[UserName].lwp` so you don't have to log in every time.
 
 ## Testing and ensuring good code quality
 
-From your base pywikitools path, use the following command to run the test
-suite.
+From your base pywikitools path (with the virtual environment set up):
 
 ```shell
-$ python -m unittest discover -s pywikitools/test
+$ make test      # run the test suite
+$ make lint      # check style with flake8
+$ make coverage  # coverage report; opens htmlcov/ in your browser
 ```
 
-Also, run the next command to check for linting issues
+The same commands without `make`:
 
 ```shell
-$ flake8
+$ python -m unittest discover -s pywikitools/test
+$ flake8 .
 ```
 
-With `GitHub Actions` these two commands are automatically run also on every
-push or pull request in the repository. The goal is to cover all important code
-with good test coverage.
+With `GitHub Actions` tests and linting run automatically on every push or pull
+request. The goal is to cover all important code with good test coverage.
 
 Some tests are making real API calls, that's why running the tests can
 take half a
@@ -139,7 +139,7 @@ Which username should it use?
 correct_bot.py
 : Automatically correct simple mistakes in texts of different languages.
 
-resources_bot.py
+resourcesbot.py
 : Automatically scan through all available translations, gather information on
 each language and do many useful things with this information.
 Such as filling out the “Available training resources in...”
@@ -187,11 +187,4 @@ For more details, see CONTRIBUTING.md
 
 Please subscribe to the repository to get informed on changes. We use GitHub
 issues for specific tasks, wishes, bugs, etc. Please don’t hesitate to open
-a new one! Assign yourself to the issues that you plan to work on.
-
-## Credits
-
-This package was created
-with [Cookiecutter](https://github.com/audreyr/cookiecutter) and
-the [audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage)
-project template.
+a new one! Assign yourself to the issues that you plan to work on.

autotranslate.py

@@ -45,7 +45,10 @@ def __init__(self, config: ConfigParser):
     def fetch_and_translate(self, page_name, language_code, force=False, simulate=False):
         translated_page = self.fortraininglib.get_translation_units(page_name, "en")
 
-        if not simulate and not force and self.fortraininglib.get_translated_title(page_name, language_code) is not None:
+        if (
+            not simulate and not force
+            and self.fortraininglib.get_translated_title(page_name, language_code) is not None
+        ):
             self.logger.warning("Translation already exists. If you want to force overwrite, use the -f flag.")
             return
 

setup.cfg

@@ -1,7 +1,5 @@
 [flake8]
 exclude = env,pywikitools/user-config.py,pywikitools/correctbot/user-config.py
 max-line-length = 120
-# TODO enable E501 for generateodt.py some day
 per-file-ignores =
     pywikitools/test/test_correctbot.py:E127
-    pywikitools/cgi-bin/generateodt.py:E501