👁️🗨️ Scientists often do the same bad stuff. Automate giving feedback during peer review.
MIT License
Scientists often do the same bad stuff. Automate giving feedback during peer review for Python packages.
Goals:
src/
or bust)pip
)black
)pyroma
doesn't pass 10/10LICENSE
fileCITATION.cff
fileExample Reviews:
Want to collaborate? What do you expect out of Python packages? Let me know in the comments. I envision this being sort of modular so people can contribute their own checks.
Desired interface:
Run on the command line with:
$ autoreviewer https://github.com/rs-costa/sbml2hyb
There's a submodule autoreviewer.jcheminf
that has utilities for scraping the paper list
from the Journal of Cheminformatics, getting their ePub files,
extracting GitHub references from the availability statements, running autoreview on each,
then making the following summary with python -m autoreviewer.jcheminf
.
The most recent release can be installed from PyPI with:
$ pip install autoreviewer
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/autoreviewer.git
You'll also need to make sure pandoc
is installed.
The best way to do this is brew install pandoc
on macOS.
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.
The code in this package is licensed under the MIT License.
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.
The final section of the README is for if you want to get involved by making a code contribution.
To install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/autoreviewer.git
$ cd autoreviewer
$ pip install -e .
After cloning the repository and installing tox
with pip install tox
, the unit tests in the tests/
folder can be
run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
The documentation can be built locally using the following:
$ git clone git+https://github.com/cthoyt/autoreviewer.git
$ cd autoreviewer
$ tox -e docs
$ open docs/build/html/index.html
The documentation automatically installs the package as well as the docs
extra specified in the setup.cfg
. sphinx
plugins
like texext
can be added there. Additionally, they need to be added to the
extensions
list in docs/source/conf.py
.
After installing the package in development mode and installing
tox
with pip install tox
, the commands for making a new release are contained within the finish
environment
in tox.ini
. Run the following from the shell:
$ tox -e finish
This script does the following:
setup.cfg
,src/autoreviewer/version.py
, and docs/source/conf.py
to not have the -dev
suffixbuild
twine
. Be sure to have a .pypirc
file configured to avoidtox -e bumpversion minor
after.