Skip to content

Remove pyproject template leftovers - #23

Merged
glenn-jocher merged 1 commit into
mainfrom
pass2-pyproject
Aug 2, 2026
Merged

Remove pyproject template leftovers#23
glenn-jocher merged 1 commit into
mainfrom
pass2-pyproject

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Aug 2, 2026

Copy link
Copy Markdown
Member

pyproject.toml still carried unmodified boilerplate from the Ultralytics Python template:

  • package-data = { "sample" = ["*.yaml"] } and the commented-out [project.scripts] sample = "sample:main" placeholder — there is no sample package here and no YAML ships in source/.
  • The overview comment said [tool.*] configures "pytest, yapf"; the file actually configures ruff and docformatter.
  • The install recipe used git+https://TOKEN:x-oauth-basic@github.com/..., implying a token is required. The repo is public, so a plain git URL works.
  • The documentation comment pointed at docs.ultralytics.com, which returns 404 for this project — docs/README.md itself says usage lives in the root README. Repointed at the README and source/run_repo.py.
  • Removed the [tool.codespell] block: its skip globs (docs/??/, docs/mkdocs_??.yml, *.csv) match nothing here and ignore-words-list was YOLO-only (strack, dota, segway, …). Verified with codespell --builtin clear,informal,en-GB_to_en-US and no ignore list: zero misspellings in the repo, so no entry was load-bearing. CI passes its own flags via ultralytics/actions, so behavior is unchanged.

[tool.setuptools] packages (the real, load-bearing key) is untouched and pyproject still parses.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🧹 Simplifies the pyproject.toml configuration and updates Source-Trace installation and documentation guidance.

📊 Key Changes

  • 🔓 Updates the installation command to use the public GitHub repository without a token.
  • 📖 Directs users to README.md and source/run_repo.py for usage and comparison details.
  • 🛠️ Refreshes tool documentation comments to reference Ruff and Docformatter instead of older tooling.
  • 🗑️ Removes unused sample package-data and commented-out script configuration.
  • ✂️ Removes the obsolete Codespell configuration block.

🎯 Purpose & Impact

  • ✅ Makes installation instructions simpler and safer by eliminating token-based authentication.
  • 🧭 Helps contributors find the correct usage and implementation documentation.
  • 🧼 Reduces outdated or unused packaging configuration, making the project easier to maintain.
  • ⚙️ Aligns the project metadata with its current development tooling and package structure.

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/source-trace 🚀 PR! This is an automated review message; an engineer will assist as needed. To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/source-trace main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

Clean PR. The removed template-only setuptools and codespell configuration has no remaining repository consumer, and the updated comments accurately reflect the current tooling and usage location.

@glenn-jocher
glenn-jocher merged commit b455074 into main Aug 2, 2026
5 checks passed
@glenn-jocher
glenn-jocher deleted the pass2-pyproject branch August 2, 2026 19:01
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Merged—thank you, @glenn-jocher, for this thoughtful cleanup of Source-Trace!

“Simplicity is the ultimate sophistication.” — Leonardo da Vinci

By removing token-based installation, clarifying usage guidance, and trimming outdated configuration, this PR makes the project safer, easier to understand, and simpler to maintain. Your contribution helps keep the repository focused and welcoming for future contributors—thank you!

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants