[](https://codecov.io/gh/bincrafters/bincrafters-conventions)
[](https://pypi.python.org/pypi/bincrafters-conventions)
# 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](LICENSE.md)
Raw data
{
"_id": null,
"home_page": "https://github.com/bincrafters/bincrafters-conventions",
"name": "bincrafters-conventions",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "conan, C/C++, package, libraries, developer, manager, dependency, tool, c, c++, cpp, convention, updates",
"author": "Bincrafters",
"author_email": "bincrafters@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/14/c9/c4008ef5d591bdc7d3848023cf8a12f324f7d379a0510539daf5933d4e4e/bincrafters_conventions-1.2.1.tar.gz",
"platform": null,
"description": "\n[](https://codecov.io/gh/bincrafters/bincrafters-conventions)\n[](https://pypi.python.org/pypi/bincrafters-conventions)\n\n# Bincrafters Conventions\n\n## A Script to update Conan projects following Conan conventions\n\nThis project contains scripts to update recipes, CI files, to\nupdate Conan conventions in general and to perform some linting.\n\n### INSTALL\n\nYou can install `bincrafters-conventions` via `pip` like this:\n\n $ pip install bincrafters_conventions\n\nMinimum Python version: `3.8`\n\n### RUN\n\n> \ud83d\udca1 Bincrafters Conventions is a command line tool.\n> \n> Execute `bincrafters-conventions --help` to see all options.\n> \n> `bincrafters-conventions` has also the alias `bcon` for convince.\n\n\n#### EXAMPLES\n\nTo update **ALL** Conan projects on GitHub for https://github.com/bincrafters\n\n $ bcon --remote=bincrafters\n\nTo update **ONLY** one project on GitHub https://github.com/bincrafters/conan-conversion\n\n $ bcon --remote=bincrafters/conan-double-conversion\n\nTo **AVOID** to execute push command after to update\n\n $ bcon --remote=bincrafters/conan-libusb --dry-run\n\nTo filter **PROJECTS** by pattern\n\n $ bcon --remote=bincrafters --project-pattern bincrafters/conan-*\n\nTo filter **BRANCHES** by pattern\n\n $ bcon --remote=bincrafters --branch-pattern stable/*\n\nor\n\n $ bcon --remote=bincrafters/conan-libzip --branch-pattern stable/*\n\nTo update and check **LOCAL** everything\n\n $ bcon\n \nTo check **LOCAL** everything\n\n $ bcon --check\n\nTo apply Conan conventions in a local file:\n\n $ bcon --conanfile=conanfile.py\n\nTo update AppVeyor file:\n\n $ bcon --appveryorfile=appveyor.yml\n\n\n### Testing and Development\n\nIf you want to install `bincrafters-conventions` via a local git clone\n\n pip install --user -U .\n\nTo install extra packages required to test\n\n pip install .[test]\n\nTo run all unit test + code coverage, execute:\n\n cd tests\n pytest -v --cov=bincrafters_conventions\n\n\n### LICENSE\n\n[MIT](LICENSE.md)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Bincrafters script to apply Conan conventions and update CI jobs",
"version": "1.2.1",
"project_urls": {
"Homepage": "https://github.com/bincrafters/bincrafters-conventions"
},
"split_keywords": [
"conan",
" c/c++",
" package",
" libraries",
" developer",
" manager",
" dependency",
" tool",
" c",
" c++",
" cpp",
" convention",
" updates"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53aeda172839d235a761bd0a21b2bd127126923b61fffdb2b960186f189ddf53",
"md5": "d51f6ad832de5e9aa4740194c2d2e27b",
"sha256": "44ae8a1441744c9daafbacb490b002fcb680a1be0346c83b949b5170f45afda3"
},
"downloads": -1,
"filename": "bincrafters_conventions-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d51f6ad832de5e9aa4740194c2d2e27b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 45683,
"upload_time": "2024-06-16T23:54:12",
"upload_time_iso_8601": "2024-06-16T23:54:12.167478Z",
"url": "https://files.pythonhosted.org/packages/53/ae/da172839d235a761bd0a21b2bd127126923b61fffdb2b960186f189ddf53/bincrafters_conventions-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14c9c4008ef5d591bdc7d3848023cf8a12f324f7d379a0510539daf5933d4e4e",
"md5": "67b8655e426490e7a3939e9b3a71ed32",
"sha256": "56d8baff28cef6c8c7b53c78b7f71fcc2932fd04f72ba361d3d0343c4b9a96fc"
},
"downloads": -1,
"filename": "bincrafters_conventions-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "67b8655e426490e7a3939e9b3a71ed32",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37821,
"upload_time": "2024-06-16T23:54:14",
"upload_time_iso_8601": "2024-06-16T23:54:14.459949Z",
"url": "https://files.pythonhosted.org/packages/14/c9/c4008ef5d591bdc7d3848023cf8a12f324f7d379a0510539daf5933d4e4e/bincrafters_conventions-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-16 23:54:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bincrafters",
"github_project": "bincrafters-conventions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "bincrafters-conventions"
}
JSON
