No project description provided
Project description
The Kraken build system
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 Pipx) to get access to thekrakenw
command-line tool. -
Create a
.kraken.py
script in your project's root directory.from kraken.common import buildscript buildscript(requirements=["kraken-build==0.32.3"]) from kraken.std.python import mypy, black, isort mypy() black() isort()
-
Run
krakenw lock
to installkraken-build
for your project inbuild/.kraken/venv
and generate akraken.lock
file. -
Run
krakenw run lint
to run the linters.
Note that you can also use the
kraken
CLI (instead ofkrakenw
), however this will disregard thebuildscript()
function, will not use the lock file and will use the version of Kraken that was installed globally.
How-to's
Upgrade a project's lock file
To upgrade a project's lock file, run krakenw lock --upgrade
. This will upgrade all dependencies to the latest
available version. If you want to upgrade based on updated constraints in .kraken.py
without installing from scratch,
add the --incremental
flag or set KRAKENW_INCREMENTAL=1
.
Development
This repository uses Slap to manage the Python project. After installing Slap with Pipx, run the following to install Kraken for development.
$ slap venv -c --python python3.10
$ slap install --link
# If you have the Slap shell magic installed, it will activate the Venv in your shell.
$ slap venv -a
You may want to use a released version of krakenw
to interact in the repository however:
$ krakenw run python.install
$ krakenw run fmt lint test
Releases
A release must be created by a maintainer that has write access to the develop
branch. The release process
is automated using Slap.
$ slap release -tp <patch|minor|major|x.y.z>
$ slap publish
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kraken_build-0.38.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 949daebbac706229179dc703e1c6c50da8e005a798e26150808e985a55878f63 |
|
MD5 | acc86e5e638aed4ddc3f3e7c376de49e |
|
BLAKE2b-256 | bc8fc02a7758700800da06ec98026f3434319ed61be49092b1e91d8a2037747f |