Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ryancheley/the-well-maintained-test

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

oss python

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/ryancheley/the-well-maintained-test
Owner: ryancheley
License: apache-2.0
Created: 2021-11-09T02:43:03.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-11-05T00:16:03.000Z (3 months ago)
Last Synced: 2024-12-15T09:40:49.533Z (about 2 months ago)
Topics: oss, python
Language: Python
Homepage:
Size: 151 KB
Stars: 23
Watchers: 2
Forks: 3
Open Issues: 3
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

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

README

        # the-well-maintained-test

[![PyPI](https://img.shields.io/pypi/v/the-well-maintained-test.svg)](https://pypi.org/project/the-well-maintained-test/)

[![Changelog](https://img.shields.io/github/v/release/ryancheley/the-well-maintained-test?include_prereleases&label=changelog)](https://github.com/ryancheley/the-well-maintained-test/releases)

[![Tests](https://github.com/ryancheley/the-well-maintained-test/workflows/Test/badge.svg)](https://github.com/ryancheley/the-well-maintained-test/actions?query=workflow%3ATest)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ryancheley/the-well-maintained-test/blob/master/LICENSE)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![Imports: flake8](https://img.shields.io/badge/%20imports-flake8-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/flake8/)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ryancheley/the-well-maintained-test/main.svg)](https://results.pre-commit.ci/latest/github/ryancheley/the-well-maintained-test/main)

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

## Installation

### pipx

The preferred method of installation for this tool is [pipx](https://pypa.github.io/pipx/).

    pipx install the-well-maintained-test

### virtual environment

This tool can be installed in a virtual environment using pip:

Create your virtual environment

    python3 -m venv venv

    source venv/bin/activate

Install with pip

    python -m 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](https://github.com/settings/tokens))

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

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

```

## Development

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

    cd the-well-maintained-test

    python3 -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

The commands below use the command runner [just](https://github.com/casey/just). If you would rather not use `just` the raw commands are also listed below

Then, to run mypy:

    just mypy

OR the raw command is

    mypy src/the_well_maintained_test/*.py --no-strict-optional

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

    just check

OR the raw commands are

    pre-commit run --all-files

    mypy src/the_well_maintained_test/*.py --no-strict-optional

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