Metadata-Version: 2.1
Name: startifact
Version: 1.0.0a4
Summary: Stages artifacts into Amazon Web Services
Home-page: https://github.com/cariad/startifact
Author: Cariad Eccleston
Author-email: cariad@cariad.earth
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ansiscape (~=1.0)
Requires-Dist: asking (~=1.0)
Requires-Dist: cline (~=1.1)
Requires-Dist: boto3 (~=1.20)

# 📦 Startifact

[![codecov](https://codecov.io/gh/cariad/startifact/branch/main/graph/badge.svg?token=DY4aEoo9Th)](https://codecov.io/gh/cariad/startifact)

**Startifact** is a command line application and Python package for staging and retrieving versioned artifacts in Amazon Web Services.

Full documentation is online at [cariad.github.io/startifact](https://cariad.github.io/startifact/startifact.html).

## Installation

```bash
pip install startifact
```

## Configuration

Startifact uses a single shared configuration across all of your CI/CD pipelines.

Full documentation is online at [cariad.github.io/startifact](https://cariad.github.io/startifact/startifact.html).

## Usage

### Staging an artifact

To stage an artifact, pass the project name, version and `--stage` argument with the path to the artifact:

```text
startifact SugarWater 1.0.9000 --stage dist.tar.gz
```

### Getting the latest version number of a project

To get the version number of the latest artifact staged for a project, pass the project name and `--get` argument for `version`:

```text
startifact SugarWater --get version
```

The version number will be emitted to `stdout`.

### Downloading an artifact

To download an artifact, pass the project name, *optionally* the version number, and the `--download` argument with the path to download to:

```text
startifact SugarWater 1.0.0 --download dist.tar.gz
```

If the version is omitted or `latest` then the latest artifact will be downloaded, otherwise the literal version will be downloaded.

## Project

### Licence

Startifact is released at [github.com/cariad/startifact](https://github.com/cariad/startifact) under the MIT Licence.

See [LICENSE](https://github.com/cariad/startifact/blob/main/LICENSE) for more information.

### Author

Hello! 👋 I'm **Cariad Eccleston** and I'm a freelance DevOps and backend engineer. My contact details are available on my personal wiki at [cariad.earth](https://cariad.earth).

Please consider supporting my open source projects by [sponsoring me on GitHub](https://github.com/sponsors/cariad/).


