[x] Fit: The package meets criteria for fit and overlap.
[x] Automated tests: Package has a testing suite and is tested via Travis-CI or another CI service.
[x] License: The package has an OSI accepted license
[x] Repository: The repository link resolves correctly
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, the badge for pyOpenSci peer-review once it has started (see below), 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, that one and that one. Such a table should be more wide than high.
[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
[x] 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
Functionality
[x] Installation: Installation succeeds as documented.
[x] Functionality: Any functional claims of the software been confirmed.
[x] 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.
Fit: our package probably best fits in the data visualization category
Overlap: Several packages combined will provide the functionality of our package but our package is still very purpose-driven for those who don't have much experience coding and would prefer to input csv and get outputted png by using some basic functions
Documentation
The package includes all the following forms of documentation:
setup.py
file or elsewhere.Readme requirements
The package meets the readme requirements below:
The README should include, from top to bottom:
Functionality