Bincrafters Conventions

A Script to update Conan projects following Conan conventions

This project contains scripts to update recipes, CI files, to update Conan conventions in general and to perform some linting.

INSTALL

You can install bincrafters-conventions via pip like this:

$ pip install bincrafters_conventions

Minimum Python version: 3.8

RUN

💡 Bincrafters Conventions is a command line tool.

Execute bincrafters-conventions --help to see all options.

bincrafters-conventions has also the alias bcon for convince.

EXAMPLES

To update ALL Conan projects on GitHub for https://github.com/bincrafters

$ bcon --remote=bincrafters

To update ONLY one project on GitHub https://github.com/bincrafters/conan-conversion

$ bcon --remote=bincrafters/conan-double-conversion

To AVOID to execute push command after to update

$ bcon --remote=bincrafters/conan-libusb --dry-run

To filter PROJECTS by pattern

$ bcon --remote=bincrafters --project-pattern bincrafters/conan-*

To filter BRANCHES by pattern

$ bcon --remote=bincrafters --branch-pattern stable/*

or

$ bcon --remote=bincrafters/conan-libzip --branch-pattern stable/*

To update and check LOCAL everything

$ bcon

To check LOCAL everything

$ bcon --check

To apply Conan conventions in a local file:

$ bcon --conanfile=conanfile.py

To update AppVeyor file:

$ bcon --appveryorfile=appveyor.yml

Testing and Development

If you want to install bincrafters-conventions via a local git clone

pip install --user -U .

To install extra packages required to test

pip install .[test]

To run all unit test + code coverage, execute:

cd tests
pytest -v --cov=bincrafters_conventions

LICENSE

MIT