Metadata-Version: 2.1
Name: bob-the-developer
Version: 0.2.4
Summary: A collection of scripts to build C++ projects
Author: René Moll
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.
        
Project-URL: Repository, https://github.com/renemoll/bob
Project-URL: Issues, https://github.com/renemoll/bob/issues
Keywords: build tool,c++
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: docopt
Requires-Dist: toml
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pydoclint ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: types-docopt ; extra == 'dev'
Requires-Dist: types-toml ; extra == 'dev'
Provides-Extra: test
Requires-Dist: docopt ; extra == 'test'
Requires-Dist: pytest >=7.4 ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'
Requires-Dist: toml ; extra == 'test'
Provides-Extra: tox
Requires-Dist: tox >=4.0 ; extra == 'tox'

========
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

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.

Roadmap
=======

1. Python support
