Metadata-Version: 2.4
Name: stepup
Version: 4.1.0rc3
Summary: A dynamic Python build tool for reproducible workflows
Author-email: Toon Verstraelen <toon.verstraelen@ugent.be>
License-Expression: LGPL-3.0-or-later
Project-URL: Documentation, https://reproducible-reporting.github.io/stepup-core/
Project-URL: Issues, https://github.com/reproducible-reporting/stepup-core/issues
Project-URL: Source, https://github.com/reproducible-reporting/stepup-core/
Project-URL: Changelog, https://reproducible-reporting.github.io/stepup-core/changelog/
Keywords: asyncio,build automation,build tool,cross-platform,dynamic dependencies,incremental build,parallel,Python,reproducibility,reproducible research,StepUp,terminal application,workflow,workflow management
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: asyncinotify>=4.0.9; sys_platform == "linux"
Requires-Dist: attrs>=23.1.0
Requires-Dist: cattrs>=23.2.3
Requires-Dist: jinja2>=3.1.6
Requires-Dist: parse>=1.19.1
Requires-Dist: path>=16.14.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0.0
Requires-Dist: watchfiles>=1.3.0; sys_platform != "linux"
Provides-Extra: tests
Requires-Dist: pytest>=8.2.0; extra == "tests"
Requires-Dist: pytest-asyncio>=0.24; extra == "tests"
Requires-Dist: pytest-timeout>=2.3.1; extra == "tests"
Requires-Dist: pytest-xdist>=3.6.1; extra == "tests"
Provides-Extra: examples
Requires-Dist: matplotlib>=3.8.0; extra == "examples"
Requires-Dist: numpy>=1.26.0; extra == "examples"
Provides-Extra: watchfiles
Requires-Dist: watchfiles>=1.3.0; extra == "watchfiles"
Provides-Extra: dev
Requires-Dist: stepup[examples,tests,watchfiles]; extra == "dev"
Requires-Dist: mkdocstrings-python; extra == "dev"
Requires-Dist: reuse; extra == "dev"
Requires-Dist: snipwise<2.0a0; extra == "dev"
Requires-Dist: yappi; extra == "dev"
Requires-Dist: zensical; extra == "dev"
Dynamic: license-file

<!--
SPDX-FileCopyrightText: 2024 Toon Verstraelen <Toon.Verstraelen@UGent.be>
SPDX-License-Identifier: LGPL-3.0-or-later
-->

# StepUp Core

[![release](https://github.com/reproducible-reporting/stepup-core/actions/workflows/release.yaml/badge.svg?branch=main)](https://github.com/reproducible-reporting/stepup-core/actions/workflows/release.yaml)
[![pytest](https://github.com/reproducible-reporting/stepup-core/actions/workflows/pytest.yaml/badge.svg?branch=main)](https://github.com/reproducible-reporting/stepup-core/actions/workflows/pytest.yaml)
[![docs](https://github.com/reproducible-reporting/stepup-core/actions/workflows/docs.yaml/badge.svg?branch=main)](https://github.com/reproducible-reporting/stepup-core/actions/workflows/docs.yaml)
[![PyPI Version](https://img.shields.io/pypi/v/stepup)](https://pypi.org/project/stepup/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22018869.svg)](https://doi.org/10.5281/zenodo.22018869)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/stepup)
![LGPL-3 License](https://img.shields.io/badge/License-LGPL_v3-blue.svg)
[![CodeFactor](https://www.codefactor.io/repository/github/reproducible-reporting/stepup-core/badge)](https://www.codefactor.io/repository/github/reproducible-reporting/stepup-core)

<!-- snipwise.md BEGIN abstract -->
StepUp is a dynamic build tool for workflows written in Python.
Like [Make](https://en.wikipedia.org/wiki/Make_(software)),
it reruns only the steps whose inputs have changed.
Unlike most build tools, StepUp starts executing steps with only partial knowledge of the workflow.
A platform-independent `plan.py` script defines the initial steps,
and while the workflow runs, any step can add more steps and dependencies,
based on the outputs built so far.
Workflows can thus grow with your work,
without having to fit your ideas into a rigid framework.
StepUp is therefore ideal for workflows that are less structured than software builds,
such as those that produce scientific publications or datasets.
<!-- snipwise.md END abstract -->

StepUp Core provides the basic framework for StepUp, without any domain-specific features.
Those live in extension packages:

- [StepUp RepRep](https://reproducible-reporting.github.io/stepup-reprep/)
  for creating **rep**roducible **rep**orts: papers, presentations, theses, etc.
- [StepUp Queue](https://reproducible-reporting.github.io/stepup-queue/)
  submits jobs to a SLURM scheduler.

## Installation

```bash
pip install stepup
```

See the [installation guide](https://reproducible-reporting.github.io/stepup-core/installation/)
for details.

## Quick Visual Impression

[![asciicast](https://asciinema.org/a/pJXDBvCXT9ndHDuo.svg)](https://asciinema.org/a/pJXDBvCXT9ndHDuo)

## Documentation

Full documentation, including a tutorial and a feature overview,
is available at <https://reproducible-reporting.github.io/stepup-core>.

## License

StepUp Core is distributed under the terms of the
[LGPL-3.0-or-later](https://github.com/reproducible-reporting/stepup-core/blob/main/LICENSE) license.
Contributions are welcome;
see the [development guide](https://reproducible-reporting.github.io/stepup-core/development/)
to get started.
