| Name | bob-the-developer JSON |
| Version |
0.2.5
JSON |
| download |
| home_page | |
| Summary | A collection of scripts to build C++ projects |
| upload_time | 2024-02-07 21:10:56 |
| maintainer | |
| docs_url | None |
| author | René Moll |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2021-2023 René Moll Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
build tool
c++
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
========
Meet Bob
========
.. image:: https://github.com/renemoll/bob/actions/workflows/unit-testing.yaml/badge.svg
:target: https://github.com/renemoll/bob/actions/workflows/unit-testing.yaml
:alt: Unit tests
.. image:: https://coveralls.io/repos/github/renemoll/bob/badge.svg?branch=main
:target: https://coveralls.io/github/renemoll/bob?branch=main
:alt: Test coverage
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Coding style
.. image:: https://img.shields.io/github/license/renemoll/bob
:target: https://github.com/renemoll/bob/blob/main/LICENSE
:alt: GitHub
Bob is my collection of build tools. The goal is to provide a simple interface
to build and test projects without having to remember or lookup various commands.
For now, this project limits itself to C/C++ projects.
How to use
==========
.. code-block:: bash
bob build
Other commands available are:
* `bootstrap`: gather dependencies and toolchain(s)
* `configure`: configure a build system.
* `install`: install the package.
Requirements
============
* Python 3.8+
* git
Development
===========
1. Setup a virtual environment and activate it:
.. code-block:: bash
python3 -m venv .env_dev
. .env_dev/bin/activate
2. Install locally:
.. code-block:: bash
pip install --editable .[dev]
3. Test:
.. code-block:: bash
pytest
Run the complete test-suite
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Setup a virtual environment and activate it:
.. code-block:: bash
python -m venv .env_tox
. .env_tox/bin/activate
2. Install locally:
.. code-block:: bash
pip install --editable .[tox]
3. Test:
.. code-block:: bash
tox
Configured tools
~~~~~~~~~~~~~~~~
1. ``black`` for code formatting.
2. ``ruff`` for linting.
3. ``pylint`` for linting.
4. ``mypy`` for static type checking.
Raw data
{
"_id": null,
"home_page": "",
"name": "bob-the-developer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "build tool,c++",
"author": "Ren\u00e9 Moll",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/06/a9/eb936c6c96bf5a24a0d21fd6cca2f1212a6ae5af1a02d8a87da6af15e4c9/bob-the-developer-0.2.5.tar.gz",
"platform": null,
"description": "========\nMeet Bob\n========\n\n.. image:: https://github.com/renemoll/bob/actions/workflows/unit-testing.yaml/badge.svg\n :target: https://github.com/renemoll/bob/actions/workflows/unit-testing.yaml\n :alt: Unit tests\n.. image:: https://coveralls.io/repos/github/renemoll/bob/badge.svg?branch=main\n :target: https://coveralls.io/github/renemoll/bob?branch=main\n :alt: Test coverage\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Coding style\n.. image:: https://img.shields.io/github/license/renemoll/bob\n :target: https://github.com/renemoll/bob/blob/main/LICENSE\n :alt: GitHub\n\nBob is my collection of build tools. The goal is to provide a simple interface\nto build and test projects without having to remember or lookup various commands.\n\nFor now, this project limits itself to C/C++ projects.\n\nHow to use\n==========\n\n.. code-block:: bash\n\n bob build\n\nOther commands available are:\n* `bootstrap`: gather dependencies and toolchain(s)\n* `configure`: configure a build system.\n* `install`: install the package.\n\nRequirements\n============\n\n * Python 3.8+\n * git\n\nDevelopment\n===========\n\n1. Setup a virtual environment and activate it:\n\n.. code-block:: bash\n\n python3 -m venv .env_dev\n . .env_dev/bin/activate\n\n2. Install locally:\n\n.. code-block:: bash\n\n pip install --editable .[dev]\n\n3. Test:\n\n.. code-block:: bash\n\n pytest\n\n\nRun the complete test-suite\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n1. Setup a virtual environment and activate it:\n\n.. code-block:: bash\n\n python -m venv .env_tox\n . .env_tox/bin/activate\n\n2. Install locally:\n\n.. code-block:: bash\n\n pip install --editable .[tox]\n\n3. Test:\n\n.. code-block:: bash\n\n tox\n\nConfigured tools\n~~~~~~~~~~~~~~~~\n\n1. ``black`` for code formatting.\n2. ``ruff`` for linting.\n3. ``pylint`` for linting.\n4. ``mypy`` for static type checking.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021-2023 Ren\u00e9 Moll Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A collection of scripts to build C++ projects",
"version": "0.2.5",
"project_urls": {
"Issues": "https://github.com/renemoll/bob/issues",
"Repository": "https://github.com/renemoll/bob"
},
"split_keywords": [
"build tool",
"c++"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "730a1686bd23e44ecb46fa371301ca99431e461e8b5cffa2cd5f89f5482eba62",
"md5": "f6583d36ffcde7165224f541e28c3c2d",
"sha256": "d64fcf4fceba6ddc8ef95cb622d84c220ca511244d8fe36e403594bd79fbf170"
},
"downloads": -1,
"filename": "bob_the_developer-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6583d36ffcde7165224f541e28c3c2d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16602,
"upload_time": "2024-02-07T21:10:55",
"upload_time_iso_8601": "2024-02-07T21:10:55.279018Z",
"url": "https://files.pythonhosted.org/packages/73/0a/1686bd23e44ecb46fa371301ca99431e461e8b5cffa2cd5f89f5482eba62/bob_the_developer-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "06a9eb936c6c96bf5a24a0d21fd6cca2f1212a6ae5af1a02d8a87da6af15e4c9",
"md5": "a2c54d521607e25f08524af3131a03b0",
"sha256": "2519eca0228c95272bac346ed8a84067b79cf24d5ac2fa7a1a2d4ef064745e72"
},
"downloads": -1,
"filename": "bob-the-developer-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "a2c54d521607e25f08524af3131a03b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18053,
"upload_time": "2024-02-07T21:10:56",
"upload_time_iso_8601": "2024-02-07T21:10:56.717576Z",
"url": "https://files.pythonhosted.org/packages/06/a9/eb936c6c96bf5a24a0d21fd6cca2f1212a6ae5af1a02d8a87da6af15e4c9/bob-the-developer-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 21:10:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "renemoll",
"github_project": "bob",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "bob-the-developer"
}
