kraken-build


Namekraken-build JSON
Version 0.48.3 PyPI version JSON
download
home_pageNone
SummaryKraken is an extensible build orchestration system.
upload_time2025-08-22 13:32:20
maintainerNone
docs_urlNone
authorNone
requires_python<3.14,>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # The Kraken build system

![kraken-logo](https://i.imgur.com/Lqjy2zi.png)

[![Python](https://github.com/kraken-build/kraken/actions/workflows/python.yaml/badge.svg)](https://github.com/kraken-build/kraken/actions/workflows/python.yaml)  
[![PyPI version](https://badge.fury.io/py/kraken-build.svg)](https://badge.fury.io/py/kraken-build)  
[![Documentation](https://img.shields.io/badge/Documentation-blue?style=flat&logo=gitbook&logoColor=white)](https://kraken-build.github.io/kraken/)

Kraken is a build system, but not in the traditional sense. It's focus is on the orchestration of high-level tasks,  
such as organization of your repository configuration, code generation, invoking other build systems, etc. It is not a  
replacement for tools like Poetry, Cargo or CMake.

**Requirements**

*   CPython 3.10+

## Getting started

Currently, Kraken's OSS components are not very well documented and do not provide a convenient way to get started.  
However, if you really want to try it, you can use the following steps:

Install `kraken-wrapper` (e.g. with [Uv](https://docs.astral.sh/uv/)) to get access to the `krakenw` command-line tool.

Create a `.kraken.py` script in your project's root directory.

Run `krakenw lock` to install `kraken-build` for your project in `build/.kraken/venv` and generate a `kraken.lock` file.

Run `krakenw run lint` to run the linters.

> Note that you can also use the `kraken` CLI (instead of `krakenw`), however this will disregard the `buildscript()`  
> function, will not use the lock file and will use the version of Kraken that was installed globally.

## Development

This repository uses [Uv](https://docs.astral.sh/uv/), but not currently a Uv-workspace because Kraken does not support that, yet. You may  
want to use a released version of `krakenw` instead of the live version in `kraken-wrapper/` to interact with this  
repository. You can use [Mise](https://mise.jdx.dev/) to install all the tools you need.

```
$ mise install
$ eval "$(mise activate)"
$ krakenw run fmt lint test
```

## Release process

A release must be created by a maintainer that has write access to the `develop` branch.

```
$ ./scripts/bump.py X.Y.Z --release
```

The packages are published to PyPI from CI.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "kraken-build",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Niklas Rosenstein <rosensteinniklas@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/41/70/55d09feb6b01847972571c3d509595e46690735444863cde5e578b69a8c9/kraken_build-0.48.3.tar.gz",
    "platform": null,
    "description": "# The Kraken build system\n\n![kraken-logo](https://i.imgur.com/Lqjy2zi.png)\n\n[![Python](https://github.com/kraken-build/kraken/actions/workflows/python.yaml/badge.svg)](https://github.com/kraken-build/kraken/actions/workflows/python.yaml)  \n[![PyPI version](https://badge.fury.io/py/kraken-build.svg)](https://badge.fury.io/py/kraken-build)  \n[![Documentation](https://img.shields.io/badge/Documentation-blue?style=flat&logo=gitbook&logoColor=white)](https://kraken-build.github.io/kraken/)\n\nKraken is a build system, but not in the traditional sense. It's focus is on the orchestration of high-level tasks,  \nsuch as organization of your repository configuration, code generation, invoking other build systems, etc. It is not a  \nreplacement for tools like Poetry, Cargo or CMake.\n\n**Requirements**\n\n*   CPython 3.10+\n\n## Getting started\n\nCurrently, Kraken's OSS components are not very well documented and do not provide a convenient way to get started.  \nHowever, if you really want to try it, you can use the following steps:\n\nInstall `kraken-wrapper` (e.g. with [Uv](https://docs.astral.sh/uv/)) to get access to the `krakenw` command-line tool.\n\nCreate a `.kraken.py` script in your project's root directory.\n\nRun `krakenw lock` to install `kraken-build` for your project in `build/.kraken/venv` and generate a `kraken.lock` file.\n\nRun `krakenw run lint` to run the linters.\n\n> Note that you can also use the `kraken` CLI (instead of `krakenw`), however this will disregard the `buildscript()`  \n> function, will not use the lock file and will use the version of Kraken that was installed globally.\n\n## Development\n\nThis repository uses [Uv](https://docs.astral.sh/uv/), but not currently a Uv-workspace because Kraken does not support that, yet. You may  \nwant to use a released version of `krakenw` instead of the live version in `kraken-wrapper/` to interact with this  \nrepository. You can use [Mise](https://mise.jdx.dev/) to install all the tools you need.\n\n```\n$ mise install\n$ eval \"$(mise activate)\"\n$ krakenw run fmt lint test\n```\n\n## Release process\n\nA release must be created by a maintainer that has write access to the `develop` branch.\n\n```\n$ ./scripts/bump.py X.Y.Z --release\n```\n\nThe packages are published to PyPI from CI.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Kraken is an extensible build orchestration system.",
    "version": "0.48.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/kraken-build/kraken-build/issues",
        "Documentation": "https://kraken-build.github.io/kraken-build/",
        "Homepage": "https://kraken-build.github.io/kraken-build/",
        "Repository": "https://github.com/kraken-build/kraken-build/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5e972c7977e4deba9d14399d7efb911699b91553a4f339cb38bf284fce090f8f",
                "md5": "e5dfa308981b826037773e54c7422e35",
                "sha256": "40e8902a8aeb6a66fecf5149a24ccb654781fe362b22ed6866516ddddf6128ab"
            },
            "downloads": -1,
            "filename": "kraken_build-0.48.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e5dfa308981b826037773e54c7422e35",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.10",
            "size": 266680,
            "upload_time": "2025-08-22T13:32:17",
            "upload_time_iso_8601": "2025-08-22T13:32:17.289801Z",
            "url": "https://files.pythonhosted.org/packages/5e/97/2c7977e4deba9d14399d7efb911699b91553a4f339cb38bf284fce090f8f/kraken_build-0.48.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "417055d09feb6b01847972571c3d509595e46690735444863cde5e578b69a8c9",
                "md5": "e69ffee49a575d783f31064bc8856471",
                "sha256": "a5db7bba483d6b185e751be6ca92a141e6230c396bf1297bc0602561a24f7df6"
            },
            "downloads": -1,
            "filename": "kraken_build-0.48.3.tar.gz",
            "has_sig": false,
            "md5_digest": "e69ffee49a575d783f31064bc8856471",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.10",
            "size": 293871,
            "upload_time": "2025-08-22T13:32:20",
            "upload_time_iso_8601": "2025-08-22T13:32:20.169417Z",
            "url": "https://files.pythonhosted.org/packages/41/70/55d09feb6b01847972571c3d509595e46690735444863cde5e578b69a8c9/kraken_build-0.48.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-22 13:32:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kraken-build",
    "github_project": "kraken-build",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "kraken-build"
}
        
Elapsed time: 8.77130s