linstall

A Python CLI to generate a list of installation commands for a package to add to README files.

Quickstart

Installation

Via pip:

pip install linstall

Via pipx:

pipx install linstall

Usage

Usage: linstall [OPTIONS] PACKAGE {JavaScript|Python}

  Generate a list of installation commands for a package to add to README
  files.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Development

• poetry install
• poetry run linstall linstall Python / poetry run linstall --version / poetry run linstall --help
• poetry check
• poetry version minor or poetry version patch (source)

Notes

• Poetry:
  • Install/Uninstall Poetry
  • curl -sSL https://install.python-poetry.org | python3 - --preview
  • poetry --version
  • poetry config --list
  • poetry config virtualenvs.in-project true
  • Dependencies:
    • Add the dependencies and just leave the version number in the pyproject.toml file for exact versions
    • poetry add click markdown-subtemplate pyperclip
    • poetry add black isort flakeheaven flake8-use-fstring --group dev
  • Delete the virtual environment: poetry env remove python (source)
• Poetry Version Plugin:
  • poetry self add poetry-version-plugin
  • poetry build
  • poetry self remove poetry-version-plugin
  • plugin does not work anymore with latest poetry 1.2.0b2 (open) issue.
• FlakeHeaven:
  • poetry run flakeheaven missed
  • poetry run flakeheaven plugins
  • poetry run flakeheaven config / poetry run flakeheaven config --plugins-only
  • poetry run flakeheaven lint ./linstall/ / poetry run flakeheaven lint --help
  • By default, FlakeHeaven runs only pyflakes and pycodestyle (source and source)
  • IDE integration documentation
  • IDE Integration fails on VSCode (open) issue and BUG: flake8heavened just runs flake8 in VSCode issue
  • poetry run flakeheaven code FS001 (source)
  • poetry run flakeheaven codes flake8-use-fstring (source)
• Commands:
  • Python:
    • pip: pip install
    • Pipenv: pipenv install
    • Poetry: poetry add
    • PDM (example): pdm add
    • Pyflow: pyflow install
  • JavaScript:
    • npm: npm install
    • Yarn: yarn add
    • pnpm: pnpm add
• shellingham package
• pipx install linstall