Metadata-Version: 2.4
Name: swippter-cli
Version: 0.1.0
Summary: Swippter production-ready software foundation CLI
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# Swippter CLI

The `swi` command prints:

```text
Swippter : Production Ready Software Foundation

Ship the Product,
Skip the Platform rebuild
```

## Run locally

Requires Python 3.9 or newer.

```bash
python -m venv .venv
source .venv/bin/activate
python -m pip install -e .
swi
```

You can also run the Python module without installing the console command:

```bash
python -m swi
```

## Test

```bash
python -m unittest discover -s tests
```

## Build from source

When cloning the repository, install the `build` frontend and build the wheel
and source distribution. The build frontend will install the declared build
backend (`setuptools`) in an isolated environment as needed.

```bash
git clone https://github.com/swippter/swi.git
cd swi
python3 -m pip install --upgrade build
python3 -m build
```

Install the locally built wheel and run the CLI:

```bash
python3 -m pip install dist/*.whl
swi
```

## Install from PyPI

After the package has been published to PyPI, install it with:

```bash
python3 -m pip install swippter-cli
```

Then run the command:

```bash
swi
```

Committing the code does not publish the package; it becomes installable this
way only after a successful PyPI upload.

## Build and upload to PyPI

The PyPI distribution name is `swippter-cli`, and the installed command is
`swi`. Confirm that this name is available on PyPI before uploading; if not,
choose a different unique distribution name.

Install the packaging tools, build the source and wheel distributions, and
check the built metadata:

```bash
python3 -m pip install --upgrade build twine
python3 -m build
python3 -m twine check dist/*
```

To try the upload on TestPyPI first:

```bash
python3 -m twine upload --repository testpypi dist/*
```

After confirming the package there, upload to PyPI:

```bash
python3 -m twine upload dist/*
```

Authenticate with a PyPI API token when prompted (or configure it through
`~/.pypirc`); do not put the token in source control.
