.. core-dev-tools documentation master file, created by
   sphinx-quickstart on Wed Sep  3 13:02:46 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

core-dev-tools
===============================================================================

``core-dev-tools`` is a Python meta-package that centralizes the standard
development toolchain for the entire ecosystem. Instead of each
project independently declaring and versioning its own development tools,
every project installs this single package and immediately has access to the
full, curated set of tools.

There is no Python source code, the value of this package is entirely in
its curated dependency list. A single ``pip install core-dev-tools`` is enough
to equip any project or CI/CD pipeline with tools for testing, linting, type
checking, security compliance, and packaging.

Updating tool versions for the entire ecosystem is a single change in this
package's ``pyproject.toml``, every downstream project picks it up on their
next install.

===============================================================================

.. image:: https://static.pepy.tech/personalized-badge/core-dev-tools?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads
    :target: https://pepy.tech/projects/core-dev-tools
    :alt: PyPI Downloads

.. image:: https://img.shields.io/pypi/pyversions/core-dev-tools.svg
    :target: https://pypi.org/project/core-dev-tools/
    :alt: Python Versions

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-dev-tools/-/blob/main/LICENSE
    :alt: License

.. image:: https://gitlab.com/bytecode-solutions/core/core-dev-tools/badges/release/pipeline.svg
    :target: https://gitlab.com/bytecode-solutions/core/core-dev-tools/-/pipelines
    :alt: Pipeline Status

.. image:: https://readthedocs.org/projects/core-dev-tools/badge/?version=latest
    :target: https://readthedocs.org/projects/core-dev-tools/
    :alt: Docs Status

.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security


Documentation Contents
-------------------------------------------------------------------------------

.. toctree::
   :maxdepth: 1
   :caption: Index:

   tools


Installation
-------------------------------------------------------------------------------

Install from PyPI using pip:

.. code-block:: bash

    pip install core-dev-tools
    uv pip install core-dev-tools  # Or using UV...


Getting Started
-------------------------------------------------------------------------------

Install once per project or environment, all tools are immediately available
on the ``PATH``:

.. code-block:: bash

    pip install core-dev-tools

Then invoke any tool directly:

.. code-block:: bash

    ruff check .             # Lint
    mypy .                   # Type check
    bandit -r .              # Security scan
    pytest -n auto --cov=.   # Tests with parallel execution and coverage
    pip-audit                # Dependency vulnerability scan


CI/CD Usage
-------------------------------------------------------------------------------

The primary motivation for this package is CI/CD pipelines. Rather than
listing every tool in each project's pipeline configuration, simply install
``core-dev-tools`` at the start of the pipeline:

.. code-block:: yaml

    # Example GitLab CI / GitHub Actions step
    - pip install core-dev-tools

Then run the tools you need in subsequent steps:

.. code-block:: bash

    ruff check .                     # Enforce code style
    pylint src/                      # Static analysis
    mypy src/                        # Type checking
    bandit -r src/                   # Security compliance
    pip-audit                        # CVE scan on dependencies
    pytest -n auto --cov=src/        # Run test suite with coverage
    tox                              # Multi-environment testing

See :doc:`tools` for the full list of available tools.


License
-------------------------------------------------------------------------------

This project is licensed under the MIT License. See the LICENSE file for details.


Links
-------------------------------------------------------------------------------

* **Documentation:** https://core-dev-tools.readthedocs.io/en/latest/
* **Repository:** https://gitlab.com/bytecode-solutions/core/core-dev-tools
* **Issues:** https://gitlab.com/bytecode-solutions/core/core-dev-tools/-/issues
* **Changelog:** https://gitlab.com/bytecode-solutions/core/core-dev-tools/-/blob/main/CHANGELOG.md
* **PyPI:** https://pypi.org/project/core-dev-tools/


Support
-------------------------------------------------------------------------------

For questions or support, please open an issue on GitLab or contact the maintainers.


Authors
-------------------------------------------------------------------------------

* **Alejandro Cora González** - *Initial work* - alek.cora.glez@gmail.com


Indices and tables
-------------------------------------------------------------------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`