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.
the-well-maintained-test --help
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/
package is a package on pypi you'd like to check:
the-well-maintained-test package 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'
Note: URL was 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 Generates a json file with your GitHub Personal Token so...
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.
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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b52e483020cc91c5b624fdcd3d574f8293eb5c9be0fbee5d4d90c05d4b4e26fb |
|
MD5 | 69ae7981d04bec7b6eda67b86d1c2c74 |
|
BLAKE2b-256 | 0796f204a595e08b5d7b048444b497418f61e9bc0ec3fa6ea0e0d311f560857e |
Hashes for the_well_maintained_test-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c40c9d1b93329428a19fe38c2856ab2623d6ad8aa97517d24d7681005b8242bf |
|
MD5 | 1af221af8366b2a54b5944633957891d |
|
BLAKE2b-256 | 2174e0ee3ad16fd3280bcda17b401e8e68960d0fa88d3c77a0e090dfe039d50b |