Skip to content

Add pyproject.toml and remove deprecated setup commands #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

cecyliaborek
Copy link

@cecyliaborek cecyliaborek commented Jul 28, 2025

  • add a minimal pyproject.toml, which is recommended for all Python projects
  • remove deprecated setup.py commands like python setup.py install and python setup.py sdist
  • update github workflows (ubuntu-latest points now to ubuntu-24.04 which doesn't have python 3.7 anymore)

Official python documentation on modernizing setup.py based projects

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR modernizes the Python packaging setup by adopting the new pyproject.toml standard and removing deprecated setup.py commands. This aligns with current Python packaging best practices and official recommendations.

  • Replaces verbose setup.py configuration with a minimal pyproject.toml file
  • Updates installation and build commands from deprecated setup.py methods to modern alternatives
  • Simplifies version management by consolidating version definition

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
pyproject.toml Adds comprehensive project configuration following modern Python packaging standards
setup.py Simplifies to minimal setup with dynamic version reading function
splunklib/__init__.py Consolidates version definition to single string format
README.md Updates installation instructions to use modern pip commands
.github/workflows/release.yml Modernizes build process to use python -m build instead of deprecated setup.py commands
Comments suppressed due to low confidence (1)

pyproject.toml:2

  • setuptools version 77.0.3 appears to be a very specific version that may not exist. Consider using a more standard version requirement like "setuptools>=68.0" or check if this exact version is available.
requires = ["setuptools>=77.0.3"]

license-files = ["LICENSE"]
description = "The Splunk Software Development Kit for Python"
readme = "README.md"
dependencies = ["deprecation>=2.1.0"]
Copy link
Preview

Copilot AI Jul 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dependency constraint has been tightened from just "deprecation" to "deprecation>=2.1.0". This could potentially break existing installations that have older versions. Consider whether this version requirement is necessary or if it should be more permissive.

Suggested change
dependencies = ["deprecation>=2.1.0"]
dependencies = ["deprecation"]

Copilot uses AI. Check for mistakes.

@cecyliaborek cecyliaborek marked this pull request as draft July 28, 2025 12:27
@cecyliaborek cecyliaborek force-pushed the DVPL-12464-add-pyproject-toml branch from 5d29384 to f023e6a Compare July 28, 2025 13:40
@cecyliaborek
Copy link
Author

Based of master instead of develop

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants