kilo59 / blue-chip Goto Github PK

Need one-line description that says more than just "blue_chip".

https://github.com/PyCQA/prospector/blob/master/LICENSE

• update license
• update pypi version
• yank earlier versions

Using invoke as the cli runner makes the project code dead simple, and seems to work fine.

However since some of the dependent tools already require click, it wouldn't add *any new dependencies to start using click (or typer).

1. Are there compelling reasons to switch to click/typer library?

Pro

• dedicated cli library
• ??

Con

• code becomes more complex
• teams that fork/copy repo can no longer just plug in their existing invoke tasks
• ??

New version of isort (5) has greatly simplified integration with black via the --profile black option.
New version of prospector uses new pylint which reverted the logging-format-style setting.

• isort update
• prospector update

Editors to support

• VS code
• Pycharm/IntelliJ
• others?

Possible integration methods

1. expose specific command-line arguments supplied

   • black
   • isort
   • prospector

2. supply configuration file path

   • prospector - individual prospector profile or profile directory
   • black?
   • isort?

3. create/append configuration file settings

   • black
   • isort
   • prospector

Dependabot couldn't authenticate with https://pypi.org/simple/.

You can provide authentication details in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'.

View the update logs.

Create a set of prospector profiles with settings compatible with the default black formatting rules.

• audit/parent
• default
• test
• docstrings

This will break normal use of bc fmt

Interferes with common bc utility on ubuntu (others?)

compatible settings at the end of black's readme on wrapping lines

[tool.isort]
multi_line_output = 3
include_trailing_comma = "True"
force_grid_wrap = 0
use_parentheses = "True"
line_length = 88

Probably need to use the command line because we can't rely on this file being present for users.

Create a cookie-cutter template (or some other tool, GitHub project templates) that can be used to quickly create a customized version of blue-chip.

#91 addresses this

• decide on documentation tools
• create doc publishing pipeline(github action?)
• demo use gif

Prospector requires using the copy-left GNU Public license and prevents using the latest versions of static analysis tools.
#35