Programatically tries to answer the 12 questions from Adam Johnson's blog post https://adamj.eu/tech/2021/11/04/the-well-maintained-test/
Project description
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 'https://github.com/ryancheley/the-well-maintained-test'
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
auth Save authentication credentials to a JSON file
questions List of questions tested
url url to a github repository you'd like to check
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'
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
the-well-maintained-test questions -q 3
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for the-well-maintained-test-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29b704bba09d69cbf049e88ba80ebefef50ba1ed93cad6c12d40b17ecaff0bb9 |
|
MD5 | 66b610f581ca3e919e5174655b1bbfe9 |
|
BLAKE2b-256 | 267122ab11e1f7551c0e75b1837d43743f461d33fa11a2a11f9294cec0eb2bec |
Hashes for the_well_maintained_test-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed81005f15022f6713b5c3023d219fa190dffc33f55ab9149acbfe578afcd00b |
|
MD5 | 4a8e47962888d02c3ee54700291dec87 |
|
BLAKE2b-256 | 2d6f061aa9a02a2cc1cb9adac2407d5d68225089066849d6d2b262b7a51fb0b2 |