Metadata-Version: 2.1
Name: salt-packets
Version: 0.2.6b4
Summary: portable, reusable, self-managed salt projects
Home-page: https://code.netprophet.tech/netp/salt-packets
Author: Leeward Bound
Author-email: lee@netprophet.tech
License: unlicensed
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: cement (==3.0.4)
Requires-Dist: jinja2
Requires-Dist: pyyaml
Requires-Dist: colorlog
Requires-Dist: colored
Requires-Dist: pyfiglet
Requires-Dist: python-dotenv
Requires-Dist: influxdb

# portable, reusable, self-managed salt projects

## Installation

```
$ pip install -r requirements.txt

$ pip install setup.py
```

## Development

This project includes a number of helpers in the `Makefile` to streamline common development tasks.

### Environment Setup

The following demonstrates setting up and working with a development environment:

```
### create a virtualenv for development

$ make virtualenv

$ source env/bin/activate


### run spack cli application

$ spack --help


### run pytest / coverage

$ make test
```


### Releasing to PyPi

Before releasing to PyPi, you must configure your login credentials:

**~/.pypirc**:

```
[pypi]
username = YOUR_USERNAME
password = YOUR_PASSWORD
```

Then use the included helper function via the `Makefile`:

```
$ make dist

$ make dist-upload
```

## Deployments

### Docker

Included is a basic `Dockerfile` for building and distributing `salt-packets`,
and can be built with the included `make` helper:

```
$ make docker

$ docker run -it spack --help
```


