the-well-maintained-test 0.8.0

Programatically tries to answer the 12 questions from Adam Johnson's blog post https://adamj.eu/tech/2021/11/04/the-well-maintained-test/

the-well-maintained-test

Programatically tries to answer the 12 questions from Adam Johnson's blog post

Installation

Install this tool using pip:

$ pip install the-well-maintained-test

Authentication

The GitHub API will rate limit anonymous calls. You can authenticate yourself with a personal token (documentation on how to generate is here)

Run this command and paste in your new token:

the-well-maintained-test auth

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.

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd the-well-maintained-test
python -m venv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

just test

To run mypy command you'll need to run

mypy --install-types

Then, to run mypy:

just mypy

You can also do a pre-commit check on the files by running

just check

This will run several pre-commit hooks, but before that it will run mypy