Open lwasser opened 5 months ago
Hey @lwasser :wave: welcome to pyOpenSci’s scientific Python peer review process!
We’ve seen your message. Someone from our editorial team will get back to you within the next week about this submission. In the meantime, feel free to check out our packaging guide or feel free to ask questions on our Discourse forum.
The submission template is missing the following values: version-submitted, target-repository, author-handle
@pyosbot assign @lwasser as eic
I'm sorry human, I don't understand that. You can see what commands I support by typing:
@pyosbot help
@pyosbot help
Hello @lwasser, here are the things you can ask me to do:
# List all available commands
@pyosbot help
# Show our community Code of Conduct and Guidelines
@pyosbot code of conduct
# Allow editors to move the review to EiC checks
@pyosbot assign eic
# Post the editor response template
@pyosbot editor response
# Replies to package accepted
@pyosbot package accepted
# Get a list of all editors's GitHub handles
@pyosbot list editors
# Assign a user as the editor of this submission
@pyosbot assign @username as editor
# Remove the editor assigned to this submission
@pyosbot remove editor
# Add to this issue's reviewers list
@pyosbot add @reviewer-login as reviewer
# Remove from this issue's reviewers list
@pyosbot remove @reviewer-login from reviewers
# Label issue with: 2/seeking-reviewers. Remove labels: 1/editor-assigned
@pyosbot seeking reviewers
# Label issue with: 3/reviewer(s)-assigned. Remove labels: 1/editor-assigned, 2/seeking-reviewers
@pyosbot reviewers assigned
# Label issue with: 4/review-in-awaiting-changes. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned
@pyosbot reviews are in
# Label issue with: 5/awaiting-reviewer-response. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned, 4/review-in-awaiting-changes
@pyosbot author response complete
# Label issue with: 7/under-joss-review. Remove labels: 4/review-in-awaiting-changes
@pyosbot begin joss
# Label issue with: 9/joss-approved. Remove labels: 7/under-joss-review
@pyosbot joss approved
# Set a value for version
@pyosbot set v1.0.0 as version
# Set a value for archive
@pyosbot set 10.5281/zenodo.7158585 as archive
# Set a value for eic
@pyosbot set @username as eic
# Remind an author, a reviewer or the editor to return to a review after a
# certain period of time (supported units days and weeks)
@pyosbot remind @reviewer in 2 weeks
# Perform checks on the repository
# Optionally, it can be run on a non-default branch
@pyosbot check repository
@pyosbot check repository from branch custom-branch-name
@pyosbot set @lwasser as eic
Done! eic is now @lwasser
@pyosbot add assignee @lwasser
I'm sorry human, I don't understand that. You can see what commands I support by typing:
@pyosbot help
@pyosbot assign eic
Hi there! Thank you for submitting your package for pyOpenSci review. Below are the basic checks that your package needs to pass to begin our review. If some of these are missing, we will ask you to work on them before the review process begins.
Please check our Python packaging guide for more information on the elements below.
import package
.README.md
file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.CONTRIBUTING.md
file that details how to install and contribute to the package.CODE_OF_CONDUCT.md
file.YAML
header of the issue (located at the top of the issue template).@pyosbot add @chayadecacao as editor
Assigned! @chayadecacao is now the editor
@pyosbot add @lwasser as editor
Assigned! @lwasser is now the editor
@pyosbot seeking reviewers
@pyosbot add @chayadecacao as reviewer
@chayadecacao added to the reviewers list!
@pyosbot reviewers assigned
@pyosbot editor response
:wave: Hi @chayadecacao! Thank you for volunteering to review for pyOpenSci!
Before beginning your review, please fill out our pre-review survey. This helps us improve all aspects of our review and better understand our community. No personal data will be shared from this survey - it will only be used in an aggregated format by our Executive Director to improve our processes and programs.
The following resources will help you complete your review:
Reviewers: Due date:
@pyosbot reviews are in
@pyosbot help
I'm sorry human, I don't understand that. You can see what commands I support by typing:
@pyosbot help
@pyosbot help
Hello @lwasser, here are the things you can ask me to do:
# List all available commands
@pyosbot help
# Show our community Code of Conduct and Guidelines
@pyosbot code of conduct
# Allow editors to move the review to EiC checks
@pyosbot assign eic
# Post the editor response template
@pyosbot editor response
# Replies to package accepted
@pyosbot package accepted
# Get a list of all editors's GitHub handles
@pyosbot list editors
# Assign a user as the editor of this submission
@pyosbot assign @username as editor
# Remove the editor assigned to this submission
@pyosbot remove editor
# Add to this issue's reviewers list
@pyosbot add @reviewer-login as reviewer
# Remove from this issue's reviewers list
@pyosbot remove @reviewer-login from reviewers
# Label issue with: 2/seeking-reviewers. Remove labels: 1/editor-assigned
@pyosbot seeking reviewers
# Label issue with: 3/reviewer(s)-assigned. Remove labels: 1/editor-assigned, 2/seeking-reviewers
@pyosbot reviewers assigned
# Label issue with: 4/review-in-awaiting-changes. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned
@pyosbot reviews are in
# Label issue with: 5/awaiting-reviewer-response. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned, 4/review-in-awaiting-changes
@pyosbot author response complete
# Label issue with: 7/under-joss-review. Remove labels: 4/review-in-awaiting-changes
@pyosbot begin joss
# Label issue with: 9/joss-approved. Remove labels: 7/under-joss-review
@pyosbot joss approved
# Set a value for version
@pyosbot set v1.0.0 as version
# Set a value for archive
@pyosbot set 10.5281/zenodo.7158585 as archive
# Set a value for eic
@pyosbot set @username as eic
# Remind an author, a reviewer or the editor to return to a review after a
# certain period of time (supported units days and weeks)
@pyosbot remind @reviewer in 2 weeks
# Perform checks on the repository
# Optionally, it can be run on a non-default branch
@pyosbot check repository
@pyosbot check repository from branch custom-branch-name
@pyosbot thank you
You are welcome
@pyosbot assign eic
Hi there! Thank you for submitting your package for pyOpenSci review. Below are the basic checks that your package needs to pass to begin our review. If some of these are missing, we will ask you to work on them before the review process begins.
Please check our Python packaging guide for more information on the elements below.
import package
.README.md
file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.CONTRIBUTING.md
file that details how to install and contribute to the package.CODE_OF_CONDUCT.md
file.YAML
header of the issue (located at the top of the issue template).@pyosbot set @chayadecacao as eic
Done! eic is now @chayadecacao
@pyosbot help
Hello @lwasser, here are the things you can ask me to do:
# List all available commands
@pyosbot help
# Show our community Code of Conduct and Guidelines
@pyosbot code of conduct
# Allow editors to move the review to EiC checks
@pyosbot assign eic
# Post the editor response template
@pyosbot editor response
# Replies to package accepted
@pyosbot package accepted
# Get a list of all editors's GitHub handles
@pyosbot list editors
# Assign a user as the editor of this submission
@pyosbot assign @username as editor
# Remove the editor assigned to this submission
@pyosbot remove editor
# Add to this issue's reviewers list
@pyosbot add @reviewer-login as reviewer
# Remove from this issue's reviewers list
@pyosbot remove @reviewer-login from reviewers
# Label issue with: 2/seeking-reviewers. Remove labels: 1/editor-assigned
@pyosbot seeking reviewers
# Label issue with: 3/reviewer(s)-assigned. Remove labels: 1/editor-assigned, 2/seeking-reviewers
@pyosbot reviewers assigned
# Label issue with: 4/review-in-awaiting-changes. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned
@pyosbot reviews are in
# Label issue with: 5/awaiting-reviewer-response. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned, 4/review-in-awaiting-changes
@pyosbot author response complete
# Label issue with: 7/under-joss-review. Remove labels: 4/review-in-awaiting-changes
@pyosbot begin joss
# Label issue with: 9/joss-approved. Remove labels: 7/under-joss-review
@pyosbot joss approved
# Set a value for version
@pyosbot set v1.0.0 as version
# Set a value for archive
@pyosbot set 10.5281/zenodo.7158585 as archive
# Set a value for eic
@pyosbot set @username as eic
# Remind an author, a reviewer or the editor to return to a review after a
# certain period of time (supported units days and weeks)
@pyosbot remind @reviewer in 2 weeks
# Perform checks on the repository
# Optionally, it can be run on a non-default branch
@pyosbot check repository
@pyosbot check repository from branch custom-branch-name
@pyosbot help
Hello @lwasser, here are the things you can ask me to do:
# List all available commands
@pyosbot help
# Show our community Code of Conduct and Guidelines
@pyosbot code of conduct
# Allow editors to move the review to EiC checks
@pyosbot start prereview
# Post the editor response template
@pyosbot editor response
# Replies to package accepted
@pyosbot package accepted
# Get a list of all editors's GitHub handles
@pyosbot list editors
# Assign a user as the editor of this submission
@pyosbot assign @username as editor
# Remove the editor assigned to this submission
@pyosbot remove editor
# Add to this issue's reviewers list
@pyosbot add @reviewer-login as reviewer
# Remove from this issue's reviewers list
@pyosbot remove @reviewer-login from reviewers
# Label issue with: 2/seeking-reviewers. Remove labels: 1/editor-assigned
@pyosbot seeking reviewers
# Label issue with: 3/reviewer(s)-assigned. Remove labels: 1/editor-assigned, 2/seeking-reviewers
@pyosbot reviewers assigned
# Label issue with: 4/review-in-awaiting-changes. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned
@pyosbot reviews are in
# Label issue with: 5/awaiting-reviewer-response. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned, 4/review-in-awaiting-changes
@pyosbot author response complete
# Label issue with: 7/under-joss-review. Remove labels: 4/review-in-awaiting-changes
@pyosbot begin joss
# Label issue with: 9/joss-approved. Remove labels: 7/under-joss-review
@pyosbot joss approved
# Set a value for version
@pyosbot set v1.0.0 as version
# Set a value for archive
@pyosbot set 10.5281/zenodo.7158585 as archive
# Set a value for eic
@pyosbot set @username as eic
# Remind an author, a reviewer or the editor to return to a review after a
# certain period of time (supported units days and weeks)
@pyosbot remind @reviewer in 2 weeks
# Perform checks on the repository
# Optionally, it can be run on a non-default branch
@pyosbot check repository
@pyosbot check repository from branch custom-branch-name
@pyosbot start prereview
Hi there! Thank you for submitting your package for pyOpenSci review. Below are the basic checks that your package needs to pass to begin our review. If some of these are missing, we will ask you to work on them before the review process begins.
Please check our Python packaging guide for more information on the elements below.
import package
.README.md
file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.CONTRIBUTING.md
file that details how to install and contribute to the package.CODE_OF_CONDUCT.md
file.YAML
header of the issue (located at the top of the issue template).@pyosbot start prereview
Hi there! Thank you for submitting your package for pyOpenSci review. Below are the basic checks that your package needs to pass to begin our review. If some of these are missing, we will ask you to work on them before the review process begins.
Please check our Python packaging guide for more information on the elements below.
import package
.README.md
file with clear explanation of what the package does, instructions on how to install it, and a link to development instructions.CONTRIBUTING.md
file that details how to install and contribute to the package.CODE_OF_CONDUCT.md
file.YAML
header of the issue (located at the top of the issue template).@pyosbot add @chayadecacao as editor
Assigned! @chayadecacao is now the editor
@pyosbot remove editor
Editor removed!
@pyosbot help
Hello @lwasser, here are the things you can ask me to do:
# List all available commands
@pyosbot help
# Show our community Code of Conduct and Guidelines
@pyosbot code of conduct
# Posts the pre-review template checklist and changes the label to 0/pre-review-checks
@pyosbot start prereview
# Post the editor response template
@pyosbot editor response
# Replies to package accepted
@pyosbot package accepted
# Get a list of all editors's GitHub handles
@pyosbot list editors
# Assign a GitHub user to the editor field of the issue and to the issue itself. Also update issue labels.
@pyosbot assign @username as editor
# Removes the current editor both from the issue header editor: field and from an assignee on the issue.
@pyosbot remove editor
# Add to this issue's reviewers list
@pyosbot add @reviewer-login as reviewer
# Remove from this issue's reviewers list
@pyosbot remove @reviewer-login from reviewers
# Adds the seeking-reviewers label to the issue and removes editor-assigned
@pyosbot seeking reviewers
# Label issue with: 3/reviewer(s)-assigned. Remove labels: 1/editor-assigned, 2/seeking-reviewers
@pyosbot reviewers assigned
# Label issue with: 4/review-in-awaiting-changes. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned
@pyosbot reviews are in
# Label issue with: 5/awaiting-reviewer-response. Remove labels: 1/editor-assigned, 2/seeking-reviewers, 3/reviewer(s)-assigned, 4/review-in-awaiting-changes
@pyosbot author response complete
# Label issue with: 7/under-joss-review. Remove labels: 4/review-in-awaiting-changes
@pyosbot begin joss
# Label issue with: 9/joss-approved. Remove labels: 7/under-joss-review
@pyosbot joss approved
# Set a value for version
@pyosbot set v1.0.0 as version
# Set a value for archive
@pyosbot set 10.5281/zenodo.7158585 as archive
# Set a value for eic
@pyosbot set @username as eic
# Remind an author, a reviewer or the editor to return to a review after a
# certain period of time (supported units days and weeks)
@pyosbot remind @reviewer in 2 weeks
# Perform checks on the repository
# Optionally, it can be run on a non-default branch
@pyosbot check repository
@pyosbot check repository from branch custom-branch-name
# Triggers a GitHub action which open a pull request to add the accepted package and all review contributors to our website.
@pyosbot update website
@pyosbot update website
@pyosbot update website
@pyosbot update website
Submitting Author: your name ( ) All current maintainers: (@github_handle1, @github_handle2) Package Name: yourPackageName One-Line Description of Package: Description here Repository Link: Version submitted: Editor-in-Chief: !--eic-->@chayadecacao<!--end-eic-- Editor: Pending
Reviewers: !--reviewers-list-->@chayadecacao<!--end-reviewers-list--
Archive: TBD JOSS DOI: TBD Version accepted: TBD
Date accepted (month/day/year): TBD
Code of Conduct & Commitment to Maintain Package
Description
Scope
Please indicate which category or categories. Check out our package scope page to learn more about our scope. (If you are unsure of which category you fit, we suggest you make a pre-submission inquiry):
Domain Specific
Community Partnerships
If your package is associated with an existing community please check below:
For all submissions, explain how the and why the package falls under the categories you indicated above. In your explanation, please address the following points (briefly, 1-2 sentences for each):
Who is the target audience and what are scientific applications of this package?
Are there other Python packages that accomplish the same thing? If so, how does yours differ?
If you made a pre-submission enquiry, please paste the link to the corresponding issue, forum post, or other discussion, or
@tag
the editor you contacted:Technical checks
For details about the pyOpenSci packaging requirements, see our packaging guide. Confirm each of the following by checking the box. This package:
Publication Options
JOSS Checks
- [ ] The package has an **obvious research application** according to JOSS's definition in their [submission requirements][JossSubmissionRequirements]. Be aware that completing the pyOpenSci review process **does not** guarantee acceptance to JOSS. Be sure to read their submission requirements (linked above) if you are interested in submitting to JOSS. - [ ] The package is not a "minor utility" as defined by JOSS's [submission requirements][JossSubmissionRequirements]: "Minor ‘utility’ packages, including ‘thin’ API clients, are not acceptable." pyOpenSci welcomes these packages under "Data Retrieval", but JOSS has slightly different criteria. - [ ] The package contains a `paper.md` matching [JOSS's requirements][JossPaperRequirements] with a high-level description in the package root or in `inst/`. - [ ] The package is deposited in a long-term repository with the DOI: *Note: JOSS accepts our review as theirs. You will NOT need to go through another full review. JOSS will only review your paper.md file. Be sure to link to this pyOpenSci issue when a JOSS issue is opened for your package. Also be sure to tell the JOSS editor that this is a pyOpenSci reviewed package once you reach this step.*Are you OK with Reviewers Submitting Issues and/or pull requests to your Repo Directly?
This option will allow reviewers to open smaller issues that can then be linked to PR's rather than submitting a more dense text based review. It will also allow you to demonstrate addressing the issue via PR links.
Confirm each of the following by checking the box.
Please fill out our survey
P.S. Have feedback/comments about our review process? Leave a comment here
Editor and Review Templates
The editor template can be found here.
The review template can be found here.