saltstack / saltstack/salt

[DOCS] saltipy is abandoned and unavailable on PyPI - salt-pepper should be the recommended Python client for salt-api

Open Beginner friendly
#69,305 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description

The Salt documentation and community references mention
saltipy as a Python client for salt-api. However saltipy
is no longer available on PyPI and appears to be abandoned.

Users following Salt documentation cannot install saltipy
and have no clear guidance on what to use instead.

This was discovered while testing salt-api authentication
on Windows 11 with Python 3.13.


Verified Environment

  • Salt Version: 3008.0 (Argon)
  • OS: Ubuntu 22.04.5 LTS (jammy) on WSL2
  • Client OS: Windows 11
  • Client Python: Python 3.13.5
  • Related issues: #69303, #69304

Steps to Reproduce

  1. Follow Salt documentation to install Python client
  2. Attempt to install saltipy on Windows:

pip install saltipy

  1. Result:

ERROR: Could not find a version that satisfies
the requirement saltipy (from versions: none)
ERROR: No matching distribution found for saltipy


Expected Result

saltipy installs successfully and connects to salt-api


Actual Result

saltipy is completely unavailable on PyPI
No alternative is mentioned in official Salt documentation


Investigation

Searched PyPI for saltipy:

  • Package does not exist on PyPI
  • Last known version was removed
  • Repository appears abandoned
  • No maintenance or updates

Tested salt-pepper as alternative:

pip install salt-pepper

Result: Installed successfully ✅

Connected to salt-api using salt-pepper:

import pepper

api = pepper.Pepper('http://SALT-API-HOST:8000')
result = api.login('saltapi', 'password', 'pam')
print('Token:', result['token'])
print('User:', result['user'])
print('Permissions:', result['perms'])

Result: Connected and authenticated successfully ✅


Comparison

saltipy salt-pepper
Available on PyPI ❌ No ✅ Yes
Last updated ❌ Abandoned ✅ Active
Salt 3008 compatible ❌ Unknown ✅ Yes
Windows compatible ❌ Unknown ✅ Yes
Python 3.13 compatible ❌ Unknown ✅ Yes
Official Salt client ❌ No ✅ Yes

Impact

  • Windows users cannot find a working Python client
  • Documentation leads users to a dead end
  • No clear error message explaining the situation
  • Users waste time trying to install unavailable package
  • Affects any new Salt user trying to use Python client

Suggested Fix

  1. Update official Salt documentation to recommend
    salt-pepper instead of saltipy

  2. Add clear note that saltipy is abandoned

  3. Add salt-pepper example to official docs:

Install the recommended Python client

pip install salt-pepper

Connect to salt-api

import pepper

api = pepper.Pepper('http://your-salt-master:8000')

Login with PAM authentication

result = api.login('username', 'password', 'pam')
token = result['token']

Run a command on all minions

response = api.local('*', 'test.ping')

  1. Consider adding salt-pepper to official
    Salt documentation as the standard Python client

Related

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the Salt documentation and community references for mentions of saltipy, then review the salt-pepper installation and salt-api authentication examples in this issue. Update the relevant guidance to identify salt-pepper as the alternative and explain that saltipy is unavailable; done means users can find an installable Python client and connection example.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
63/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.