Skip to content
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

Normalizing twarc2 commands #608

Open
igorbrigadir opened this issue Mar 12, 2022 · 3 comments
Open

Normalizing twarc2 commands #608

igorbrigadir opened this issue Mar 12, 2022 · 3 comments
Labels
cli Issues with command line interface

Comments

@igorbrigadir
Copy link
Contributor

igorbrigadir commented Mar 12, 2022

I'm finding that some command line commands are starting to diverge, and become inconsistent. This issue is just for investigating this and coordinating some changes i think we should make. Maybe some breaking changes? It would be great to align all the commands so that they have consistent commonalities and documentation and examples.

To begin with:

@igorbrigadir igorbrigadir added the cli Issues with command line interface label Mar 12, 2022
@SamHames
Copy link
Contributor

I'm in favour of this, especially if it means we stop guessing or inferring what was intended.

This is probably enough of a breaking change that we'd want to have at least a major version bump, and ideally some nice managing of errors that we can tell people about the new syntax. This would also let us standardise the handling of usernames, so hopefully we don't have to deal with other instances like #568 and #542.

@igorbrigadir
Copy link
Contributor Author

Maybe all commands that do bulk operations on an input text file vs a single argument should be like twarc2 bulk followers input.txt output.txt ? Just another idea.

@SamHames
Copy link
Contributor

I like the ID of a bulk subcommand, I can definitely see how that would contribute to consistency: anything that takes an input file is a bulk command, everything that takes an argument on the command line is at the top level.

That also gives us a nicer migration path because we can decouple creating new (more consistent) commands under bulk from removing the old commands, allowing for some deprecation warnings or similar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Issues with command line interface
Projects
None yet
Development

No branches or pull requests

2 participants