API: Rename showtable to showtable-astropy - #18047

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

• Do the proposed changes actually accomplish desired goals?
• Do the proposed changes follow the Astropy coding guidelines?
• Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
• Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
• Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
• Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
• Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
• Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
• At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

Should stay in draft until main is ready to be v8.0.dev

Any reasons why this have to stay on dev for another half year? I mean it's not like there will be a deprecation period, so users won't be able to pick up on this gracefully

Hmm I thought we said we can only break API on vX.0.0 release?

ahh, ok, fair enough

Concerning deprecation: one could still have a showtable script for a while that prints a deprecation message and then runs showtable-astropy, but I am not sure whether this is worth the effort.

Agreed, we should have a deprecation message. I think an easy way is by defining a new function in showtable.py:

def main_deprecated(args=None):
    warnings.warn(....)  # *Visible* Deprecation warning
    main(args)

Then:

showtable = "astropy.table.scripts.showtable:main_deprecated"

Having a deprecation command would be good, and pretty easy to do as @taldcroft suggests. Can we get this in before feature freeze @pllim?

OK I can work on that. Thanks for the suggestions!

Okay, I deprecated showtable and updated milestone, as suggested. With current state of the PR, it would be lie this:

$ showtable  simple_csv.csv
WARNING: AstropyDeprecationWarning: The showtable function is deprecated and may be removed in a future version.
        Use showtable-astropy instead. [__main__]
 a   b   c
--- --- ---
  1   2   3
  4   5   6
$ showtable-astropy  simple_csv.csv
 a   b   c
--- --- ---
  1   2   3
  4   5   6

devdeps failure is unrelated

Thanks for the quick reviews!