Preparing Software Publication

[dataspider]

Checklist

Primary responsibilities assigned following our discussion, feel free to modify/object. Once an item is considered done, check its box. Async discussion in the thread for this issue.

General checks

• [x] Source code publicly available on GitHub
• [x] OSI approved plain-text LICENSE file
• [x] Author contribution

Functionality

• [x] Installation possible via pypi @arashbm
• [x] Cleaner handling of Networkx dependency @arashbm
• [x] Networkx 3.x support (optional) @arashbm
• [x] Graphlet functionality (handling Bliss dependency: make it compatible w/ Python 3, replace by SOTA graph isomorphism library, ...?) @arashbm + @ercco
• [x] Update project requirements/toml to reflect Networkx 3.x support @arashbm

Code quality

• [x] (Almost) full test coverage @ercco (graphlet + sampling functionality), all others for the rest
• [x] Automated testing (GitHub actions) @arashbm
• [x] Codecov integration (optional) @dataspider
• [x] Codeclimate integration (optional) @dataspider

Documentation

• [x] Installation instructions + clearly stated list of dependencies + automated package management @arashbm
• [x] Automated documentation (sphinx + GitHub actions) @arashbm
• [x] Code of conduct (w/ MK contact webpage as default contact point) @dataspider

Writeup

• [x] Separate "publication" branch @dataspider
• [x] Writing folder "paper" with "paper.md" and "paper.bib" in it @dataspider
• [x] Summary of purpose and high-level functionality @bolozna (first draft)
• [x] Statement of need @ercco (first draft)
• [x] State of the field ("related packages", papers using pymnet already) @ercco (first draft)
• [x] Example usage with code examples and pretty figures @ercco + @dataspider
• [x] High-quality writing @dataspider
• [x] Complete references using rmarkdown citation syntax @dataspider
• [x] Check acknowledgements section + add grant number @bolozna

Bells and Whistles

• [x] Docstrings for remaining API methods + add to references.rst @ercco (graphlet + sampling functionality)
• [ ] Other CI (incl. updating pypi package) @arashbm
• [x] State-of-the-art example data provision @dataspider
• [x] Example usage (old tutorials -> ipynb tutorials) @dataspider
• [x] Proof-reading all tutorials @dataspider
• [ ] Proof-reading all docstrings @dataspider
• [x] Community guidelines (see GitHub's templates) @dataspider @arashbm