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:
pytest
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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58617bc9677521e529b8607dd2d03e13803a185ccb400f7621497c0691132451 |
|
MD5 | 78891a8f4c7c12c5f1238cfb09ad12b9 |
|
BLAKE2b-256 | af3135950fd013706b5534640bffef54c0b20b12d87db1df592c2c087b702786 |
Hashes for the_well_maintained_test-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e05e2fc345a315b838fb3694437867a4b02223b544fbab15bfdc8dc17bb14efd |
|
MD5 | b45c5c3de5a287c7fd3cf99c1324e459 |
|
BLAKE2b-256 | 61bd8ba07d539d9cb23a509e128568d47d604e1a07f86afb04ebec81365cb60a |