Skip to content

More clean up of the scripts #19372

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
datapythonista opened this issue Jan 24, 2018 · 11 comments
Closed

More clean up of the scripts #19372

datapythonista opened this issue Jan 24, 2018 · 11 comments

Comments

@datapythonista
Copy link
Member

In #18949, scripts have been improved, to respect PEP-8, to be executable, and a description on what they do has been added to the header. But some tasks are still pending:

  • Replace old string formatting with % by new with .format()
  • Review which scripts are still in use or can be useful
  • Review which of the ones to keep work as expected (there are connections to GitHub API that could change, some were implemented for Python 2, and probably haven't been reviewed much since then)
  • Add them to the documentation about contributing to pandas
  • Unify the ones that make sense (the ones that look for issues with docstrings for example, or the ones that build the release)

Next are the available scripts.

Scripts for the release manager

  • announce.py : Script to generate contributor and pull request lists
  • build_dist_for_release.sh : This builds the release cleanly & is building on the current checkout
  • build_dist.sh : Build the distribution

Script to check the docstrings

  • api_rst_coverage.py : Script to generate a report with the coverage of the API in the docs
  • find_undoc_args.py : Script that compares the signature arguments with the ones in the docsting and returns the differences

Other tools for developers

  • convert_deps.py : Convert the conda environment.yaml to a pip requirements.txt
  • find_commits_touching_func.py : Search the git history for all commits touching a named method
  • list_future_warnings.sh : Check all future warnings in Python files, and report them with the version where the FutureWarning was added (useful to find deprecated functions and methods that were supposed to be removed)
  • merge-pr.py : Utility for creating well-formed pull request merges and pushing them to Apache?
@jreback jreback added this to the Next Major Release milestone Jan 24, 2018
@jreback
Copy link
Contributor

jreback commented Jan 24, 2018

merge-pr.py is the way we merge PR's when not using the web interface.

@bhaveshpoddar94
Copy link
Contributor

Beginner Here. Do you want to add this to the Documentation? I can take this up.

@ProsperousHeart
Copy link
Contributor

I would also like to help. @datapythonista ? how can we get started on this for you?

@ProsperousHeart
Copy link
Contributor

This issue shows to be closed?

@datapythonista
Copy link
Member Author

@ProsperousHeart this issue is still open. I think a good start is to add the scripts to the documentation. Feel free to do it the way you think it's better, and send a pull request, so it can be some discussion on your code.

@ProsperousHeart
Copy link
Contributor

ProsperousHeart commented Apr 16, 2018

So just so I understand ... the bullet points are the needs, and the scripts are what the needs are to be applied to? I think that's what is being mentioned here. I'll work on this. ^_^ Thank you!

And by "this issue looks to be closed" I was referring to #18949

@ProsperousHeart
Copy link
Contributor

Unable to locate files in 2nd list of docs ... and the 1st list of scripts don't seem to have the issues for docs, though I did find one issue I don't know how to resolve ...

author_msg doesn't exist here

@abi-aryan
Copy link

@datapythonista @ProsperousHeart is still an open issue?

@jbrockmendel
Copy link
Member

@datapythonista same suggestion w/r/t checkboxes

@datapythonista
Copy link
Member Author

Yep, I think it can make sense here. Not sure what's the status of this, but the scripts are now in the linting, so they are probably better than when the issue was created.

Will have a look at the state of this next week, and I'll add the checkboxes or I'll create new issues for the pending tasks, so we can move forward with this.

@datapythonista
Copy link
Member Author

Superseded by #31038 and #31039

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

No branches or pull requests

6 participants