Submission: pyeasytries (Python)

[shoebillm]

Submitting Author: Jordon Lau(@jordanlau123), Kaicheng Tan(@Andrew-Tan), Rachel Xu (@rainbowxyt0305), Mitchie Zhao (@shoebillm) Package Name: pyeasytries One-Line Description of Package: A python package that stores words in trie structures to facilitate searching. Repository Link: pyeasytries Version submitted: v0.4.0 Editor: Tiffany Timbers (@ttimbers )
Reviewer 1: TBD
Reviewer 2: TBD
Archive: TBD
Version accepted: TBD

---

Description

• Include a brief paragraph describing what your package does:

The pyeasytries package is a simple tool to aid word insertion, deletion, and searching in the trie data structure to reduce the searching time complexity from O(mlog(n)) using a balanced binary search tree to O(m). Users can pass any words to be stored for later-on searching or printing with certain prefix, and even modify the words in storage. pyeasytries contains two classes Trie and TrieNode, and the Trie class contains four functions: add(), contain(), find_prefix() and delete().

Scope

• Please indicate which category or categories this package falls under:
  • [X] Data retrieval
  • [ ] Data extraction
  • [ ] Data munging
  • [ ] Data deposition
  • [ ] Reproducibility
  • [ ] Geospatial
  • [ ] Education
  • [ ] Data visualization*

* Please fill out a pre-submission inquiry before submitting a data visualization package. For more info, see notes on categories of our guidebook.

• Explain how the and why the package falls under these categories (briefly, 1-2 sentences):

  The pyeasytries can store any words passed by the user for facilitating later searching. "Trie" is an infix of the word "retrieving".

• Who is the target audience and what are scientific applications of this package?

  The target audience is the users who would like to quickly access pre-stored words by full spelling or prefix. The scientific applications of this package can be in predictive text and autocomplete dictionary (potentially spell checking).

• Are there other Python packages that accomplish the same thing? If so, how does yours differ?

  There is a similar Python package named pygtrie, which contains Trie, CharTrie and StringTrie classes and multiple functions. Compared to pygtrie, the pyeasytrie package is more user-friendly as it does not require the user to have too much programming background knowledge to create the tries or search through the tries.

• 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:

• [X] does not violate the Terms of Service of any service it interacts with.
• [X] has an OSI approved license.
• [X] contains a README with instructions for installing the development version.
• [X] includes documentation with examples for all functions.
• [X] contains a vignette with examples of its essential functions and uses.
• [X] has a test suite.
• [x] has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.

Publication options

• [ ] Do you wish to automatically submit to the Journal of Open Source Software? If so:

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: Do not submit your package separately to JOSS*

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.

• [x] Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.

Code of conduct

• [X] I agree to abide by pyOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.

P.S. *Have feedback/comments about our review process? Leave a comment here

Editor and Review Templates

Editor and review templates can be found here

[jraza19]

Package Review

• [x] As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor before starting your review).

Documentation

The package includes all the following forms of documentation:

• [x] A statement of need clearly stating problems the software is designed to solve and its target audience in README
• [x] Installation instructions: for the development version of package and any non-standard dependencies in README
• [x] Vignette(s) demonstrating major functionality that runs successfully locally
• [x] Function Documentation: for all user-facing functions
• [x] Examples for all user-facing functions
• [x] Community guidelines including contribution guidelines in the README or CONTRIBUTING.
• [x] Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a setup.py file or elsewhere.

Readme requirements The package meets the readme requirements below:

• [x] Package has a README.md file in the root directory.

The README should include, from top to bottom:

• [x] The package name
• [x] Badges for continuous integration and test coverage, a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the badge for pyOpenSci peer-review will be provided upon acceptance.)
• [x] Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README.
• [x] Installation instructions
• [ ] Any additional setup required (authentication tokens, etc)
• [x] Brief demonstration usage
• [x] Direction to more detailed documentation (e.g. your documentation files or website).
• [x] If applicable, how the package compares to other similar packages and/or how it relates to other packages
• [x] Citation information

Usability

Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole. Package structure should follow general community best-practices. In general please consider:

• [x] The documentation is easy to find and understand
• [x] The need for the package is clear
• [x] All functions have documentation and associated examples for use

Functionality

• [x] Installation: Installation succeeds as documented.

• [ ] Functionality: Any functional claims of the software been confirmed.

• See below notes for functionality inconsistencies.

• [ ] Performance: Any performance claims of the software been confirmed.

• [x] Automated tests: Tests cover essential functions of the package and a reasonable range of inputs and conditions. All tests pass on the local machine.

• [x] Continuous Integration: Has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.

• [x] Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.

For packages co-submitting to JOSS

• [ ] The package has an obvious research application according to JOSS's definition in their submission requirements.

Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.

The package contains a paper.md matching JOSS's requirements with:

• [ ] A short summary describing the high-level functionality of the software
• [ ] Authors: A list of authors with their affiliations
• [ ] A statement of need clearly stating problems the software is designed to solve and its target audience.
• [ ] References: with DOIs for all those that have one (e.g. papers, datasets, software).

Final approval (post-review)

• [ ] The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing:

• 1 hour

---

Review Comments

Hi pyeasytries Team!

Great work on this package! This is a really neat idea and although, I have not timed the queries explicitly, they seemed to be quite fast!

Please see below for some pointers below, I have split them up into two groups because some comments are just nice to haves.

• Slight inconsistency with add and contain function - the add function allows me to add words that are capitalized such as "Hey" because it returns true but because the contain function lowercases the word before checking for it in the trie structure, so trie.contain("Hey")returns False. But trie.find_prefix("He") returns a list with ["Hey"].Consider adding documentation and functionality to add function (to only have lowercases) or updating the functionality of the contain function to check not just lowercase words.
• The function add also lets me add a whole sentence "Hey this is it" or just punctuation "!" as well. The contain function is defensive against both cases (results in an error) but I can see both when I use find_prefix. If this is not an intended part of your package functionality, consider adding tests to defend against this the way you have in the contain function and updating the documentation.
• Currently, the functions are set up so that "Hey" is different than "hey". It might be important to include that in your documentation so that users are aware of this.

Nice to have:

• slight formatting issues with the documentation on read the docs
• if you ever decide to further enhance this package, it would be nice to be able to allow the user to add multiple words at one time such as a list

Great work overall 👍

[jordanlau123]

Hi @jraza19

Thank you for taking the time to review and leave us feedback! I will contact the team in regards to the inconsistencies you have pointed out. We will get back to you after we implement the changes. In addition, thanks for providing future package enhancements ideas, we will definitely consider them moving forward.

-pyeasytries

[GuanshuTao]

• [x] As the reviewer I confirm that there are no conflicts of interest for me to review this work (If you are unsure whether you are in conflict, please speak to your editor before starting your review).

Documentation

The package includes all the following forms of documentation:

• [x] A statement of need clearly stating problems the software is designed to solve and its target audience in README
• [x] Installation instructions: for the development version of package and any non-standard dependencies in README
• [x] Vignette(s) demonstrating major functionality that runs successfully locally
• [x] Function Documentation: for all user-facing functions
• [x] Examples for all user-facing functions
• [x] Community guidelines including contribution guidelines in the README or CONTRIBUTING.
• [x] Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a setup.py file or elsewhere.

Readme requirements The package meets the readme requirements below:

• [x] Package has a README.md file in the root directory.

The README should include, from top to bottom:

• [x] The package name
• [x] Badges for continuous integration and test coverage, a repostatus.org badge, and any other badges. If the README has many more badges, you might want to consider using a table for badges: see this example. Such a table should be more wide than high. (Note that the badge for pyOpenSci peer-review will be provided upon acceptance.)
• [x] Short description of goals of package, with descriptive links to all vignettes (rendered, i.e. readable, cf the documentation website section) unless the package is small and there’s only one vignette repeating the README.
• [x] Installation instructions
• [ ] Any additional setup required (authentication tokens, etc)
• [x] Brief demonstration usage
• [x] Direction to more detailed documentation (e.g. your documentation files or website).
• [x] If applicable, how the package compares to other similar packages and/or how it relates to other packages
• [x] Citation information

Usability

Reviewers are encouraged to submit suggestions (or pull requests) that will improve the usability of the package as a whole. Package structure should follow general community best-practices. In general please consider:

• [x] The documentation is easy to find and understand
• [x] The need for the package is clear
• [x] All functions have documentation and associated examples for use

Functionality

• [x] Installation: Installation succeeds as documented.
• [ ] Functionality: Any functional claims of the software been confirmed.
• [ ] Performance: Any performance claims of the software been confirmed.
• [x] Automated tests: Tests cover essential functions of the package and a reasonable range of inputs and conditions. All tests pass on the local machine.
• [x] Continuous Integration: Has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.
• [x] Packaging guidelines: The package conforms to the pyOpenSci packaging guidelines.

For packages co-submitting to JOSS

• [ ] The package has an obvious research application according to JOSS's definition in their submission requirements.

Note: Be sure to check this carefully, as JOSS's submission requirements and scope differ from pyOpenSci's in terms of what types of packages are accepted.

The package contains a paper.md matching JOSS's requirements with:

• [ ] A short summary describing the high-level functionality of the software
• [ ] Authors: A list of authors with their affiliations
• [ ] A statement of need clearly stating problems the software is designed to solve and its target audience.
• [ ] References: with DOIs for all those that have one (e.g. papers, datasets, software).

Final approval (post-review)

• [ ] The author has responded to my review and made changes to my satisfaction. I recommend approving this package.

Estimated hours spent reviewing:

• 2 hours

---

Review Comments

Hi pyeasytries team!

General comments: I really enjoyed reviewing this package and the idea is very interesting and attractive to me. Also, I think this package is easy to use, and happy to play around with it. The coding part is neat and DRY. I tried all functions and they are all working nicely. It is convenient to use because there are no other dependencies. You have done a great job!

Specific parts:

• I tried installation commands in both README.md and documentation website, the first one worked but the one from documentation does not work in my terminal. Please fix that(I am on Windows 10, Python 3.8.3)
• I found the same thing as Javaria that the function treats capitalized words and the same words with lowercase as different words. I tried trie.add("MIke") and trie.contain("Mike") gives me a False. I think it is better to treat them as the same word because a dictionary will work this way.
• The documents and README are clear and I enjoyed going through the examples.
• I liked the idea that you put everything into a class while developing the codes, they are easy to read and understand.
• It would be nice to have your names with emails in contributing doc().

Personal idea add-ons: I really liked this package and I think it may be a good idea if the add function can also add sentences and add each word from the sentences to the trie. So users can also type a sentence and add several words in a single call of the add function.