<h1 align="center">
AutoReviewer
</h1>
<p align="center">
<a href="https://github.com/cthoyt/autoreviewer/actions?query=workflow%3ATests">
<img alt="Tests" src="https://github.com/cthoyt/autoreviewer/workflows/Tests/badge.svg" />
</a>
<a href="https://pypi.org/project/autoreviewer">
<img alt="PyPI" src="https://img.shields.io/pypi/v/autoreviewer" />
</a>
<a href="https://pypi.org/project/autoreviewer">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/autoreviewer" />
</a>
<a href="https://github.com/cthoyt/autoreviewer/blob/main/LICENSE">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/autoreviewer" />
</a>
<a href='https://autoreviewer.readthedocs.io/en/latest/?badge=latest'>
<img src='https://readthedocs.org/projects/autoreviewer/badge/?version=latest' alt='Documentation Status' />
</a>
<a href="https://codecov.io/gh/cthoyt/autoreviewer/branch/main">
<img src="https://codecov.io/gh/cthoyt/autoreviewer/branch/main/graph/badge.svg" alt="Codecov status" />
</a>
<a href="https://github.com/cthoyt/cookiecutter-python-package">
<img alt="Cookiecutter template from @cthoyt" src="https://img.shields.io/badge/Cookiecutter-snekpack-blue" />
</a>
<a href='https://github.com/psf/black'>
<img src='https://img.shields.io/badge/code%20style-black-000000.svg' alt='Code style: black' />
</a>
<a href="https://github.com/cthoyt/autoreviewer/blob/main/.github/CODE_OF_CONDUCT.md">
<img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"/>
</a>
</p>
Scientists often do the same bad stuff. Automate giving feedback during peer review for Python packages.
Goals:
1. Given a GitHub repository, automate finding common issues such as
- No setup.py/setup.cfg/pyproject.toml
- No zenodo archive linked from the README
- Non-standard code layout (`src/` or bust)
- Files contain hard-coded file paths
- No documentation (search README for link to readthedocs)
- Package name doesn't match github repository name
- No reproducible installation instructions (i.e., does the README contain `pip`)
- Uses conda for installation
- Code does not have consistent style (i.e., there's no configuration for `black`)
- `pyroma` doesn't pass 10/10
- missing `LICENSE` file
- missing `CITATION.cff` file
2. Automate sending issues to the repository instructing how to do these things
- Use deterministic titles for all issues to avoid duplicates / make idempotent
- Create and edit "epic" issue that links others
Example Reviews:
- https://github.com/fanavarro/lexical-analysis-obo-foundry/issues/4
- https://github.com/krishnanlab/PecanPy/issues/12
- https://github.com/huihui1126/drugSim-pathway/issues/14
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:
```shell
$ autoreviewer https://github.com/rs-costa/sbml2hyb
```
## J. Chem. Inf. Analysis
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`.
## 🚀 Installation
The most recent release can be installed from
[PyPI](https://pypi.org/project/autoreviewer/) with:
```bash
$ pip install autoreviewer
```
The most recent code and data can be installed directly from GitHub with:
```bash
$ pip install git+https://github.com/cthoyt/autoreviewer.git
```
You'll also need to make sure [`pandoc`](https://pandoc.org/) is installed.
The best way to do this is `brew install pandoc` on macOS.
## 👐 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See
[CONTRIBUTING.md](https://github.com/cthoyt/autoreviewer/blob/master/.github/CONTRIBUTING.md) for more information on
getting involved.
## 👋 Attribution
### ⚖️ License
The code in this package is licensed under the MIT License.
### 🍪 Cookiecutter
This package was created with [@audreyfeldroy](https://github.com/audreyfeldroy)'s
[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using [@cthoyt](https://github.com/cthoyt)'s
[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack) template.
## 🛠️ For Developers
<details>
<summary>See developer instructions</summary>
The final section of the README is for if you want to get involved by making a code contribution.
### Development Installation
To install in development mode, use the following:
```bash
$ git clone git+https://github.com/cthoyt/autoreviewer.git
$ cd autoreviewer
$ pip install -e .
```
### 🥼 Testing
After cloning the repository and installing `tox` with `pip install tox`, the unit tests in the `tests/` folder can be
run reproducibly with:
```shell
$ tox
```
Additionally, these tests are automatically re-run with each commit in
a [GitHub Action](https://github.com/cthoyt/autoreviewer/actions?query=workflow%3ATests).
### 📖 Building the Documentation
The documentation can be built locally using the following:
```shell
$ 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`](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`](docs/source/conf.py).
### 📦 Making a Release
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:
```shell
$ tox -e finish
```
This script does the following:
1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the version number in the `setup.cfg`,
`src/autoreviewer/version.py`, and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix
2. Packages the code in both a tar archive and a wheel using [`build`](https://github.com/pypa/build)
3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to have a `.pypirc` file configured to avoid
the need for manual input at this
step
4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can
use `tox -e bumpversion minor` after.
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/cthoyt/autoreviewer",
"name": "autoreviewer",
"maintainer": "Charles Tapley Hoyt",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "cthoyt@gmail.com",
"keywords": "snekpack, cookiecutter",
"author": "Charles Tapley Hoyt",
"author_email": "cthoyt@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/fb/2e763bef65a2f33138a87afa1fda2cb7674b823d010260c64d4affba0d28/autoreviewer-0.0.5.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n AutoReviewer\n</h1>\n\n<p align=\"center\">\n <a href=\"https://github.com/cthoyt/autoreviewer/actions?query=workflow%3ATests\">\n <img alt=\"Tests\" src=\"https://github.com/cthoyt/autoreviewer/workflows/Tests/badge.svg\" />\n </a>\n <a href=\"https://pypi.org/project/autoreviewer\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/autoreviewer\" />\n </a>\n <a href=\"https://pypi.org/project/autoreviewer\">\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/autoreviewer\" />\n </a>\n <a href=\"https://github.com/cthoyt/autoreviewer/blob/main/LICENSE\">\n <img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/autoreviewer\" />\n </a>\n <a href='https://autoreviewer.readthedocs.io/en/latest/?badge=latest'>\n <img src='https://readthedocs.org/projects/autoreviewer/badge/?version=latest' alt='Documentation Status' />\n </a>\n <a href=\"https://codecov.io/gh/cthoyt/autoreviewer/branch/main\">\n <img src=\"https://codecov.io/gh/cthoyt/autoreviewer/branch/main/graph/badge.svg\" alt=\"Codecov status\" />\n </a> \n <a href=\"https://github.com/cthoyt/cookiecutter-python-package\">\n <img alt=\"Cookiecutter template from @cthoyt\" src=\"https://img.shields.io/badge/Cookiecutter-snekpack-blue\" /> \n </a>\n <a href='https://github.com/psf/black'>\n <img src='https://img.shields.io/badge/code%20style-black-000000.svg' alt='Code style: black' />\n </a>\n <a href=\"https://github.com/cthoyt/autoreviewer/blob/main/.github/CODE_OF_CONDUCT.md\">\n <img src=\"https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg\" alt=\"Contributor Covenant\"/>\n </a>\n</p>\n\nScientists often do the same bad stuff. Automate giving feedback during peer review for Python packages.\n\nGoals:\n\n1. Given a GitHub repository, automate finding common issues such as\n - No setup.py/setup.cfg/pyproject.toml\n - No zenodo archive linked from the README\n - Non-standard code layout (`src/` or bust)\n - Files contain hard-coded file paths\n - No documentation (search README for link to readthedocs)\n - Package name doesn't match github repository name\n - No reproducible installation instructions (i.e., does the README contain `pip`)\n - Uses conda for installation\n - Code does not have consistent style (i.e., there's no configuration for `black`)\n - `pyroma` doesn't pass 10/10\n - missing `LICENSE` file\n - missing `CITATION.cff` file\n2. Automate sending issues to the repository instructing how to do these things\n - Use deterministic titles for all issues to avoid duplicates / make idempotent\n - Create and edit \"epic\" issue that links others\n\nExample Reviews:\n\n- https://github.com/fanavarro/lexical-analysis-obo-foundry/issues/4\n- https://github.com/krishnanlab/PecanPy/issues/12\n- https://github.com/huihui1126/drugSim-pathway/issues/14\n\nWant to collaborate? What do you expect out of Python packages? Let me know in the comments. I envision this being sort\nof modular so people can contribute their own checks.\n\nDesired interface:\n\nRun on the command line with:\n\n```shell\n$ autoreviewer https://github.com/rs-costa/sbml2hyb\n```\n\n## J. Chem. Inf. Analysis\n\n\n\nThere's a submodule `autoreviewer.jcheminf` that has utilities for scraping the paper list\nfrom the Journal of Cheminformatics, getting their ePub files,\nextracting GitHub references from the availability statements, running autoreview on each,\nthen making the following summary with `python -m autoreviewer.jcheminf`.\n\n## \ud83d\ude80 Installation\n\nThe most recent release can be installed from\n[PyPI](https://pypi.org/project/autoreviewer/) with:\n\n```bash\n$ pip install autoreviewer\n```\n\nThe most recent code and data can be installed directly from GitHub with:\n\n```bash\n$ pip install git+https://github.com/cthoyt/autoreviewer.git\n```\n\nYou'll also need to make sure [`pandoc`](https://pandoc.org/) is installed.\nThe best way to do this is `brew install pandoc` on macOS.\n\n## \ud83d\udc50 Contributing\n\nContributions, whether filing an issue, making a pull request, or forking, are appreciated. See\n[CONTRIBUTING.md](https://github.com/cthoyt/autoreviewer/blob/master/.github/CONTRIBUTING.md) for more information on\ngetting involved.\n\n## \ud83d\udc4b Attribution\n\n### \u2696\ufe0f License\n\nThe code in this package is licensed under the MIT License.\n\n### \ud83c\udf6a Cookiecutter\n\nThis package was created with [@audreyfeldroy](https://github.com/audreyfeldroy)'s\n[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using [@cthoyt](https://github.com/cthoyt)'s\n[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack) template.\n\n## \ud83d\udee0\ufe0f For Developers\n\n<details>\n <summary>See developer instructions</summary>\n\n\nThe final section of the README is for if you want to get involved by making a code contribution.\n\n### Development Installation\n\nTo install in development mode, use the following:\n\n```bash\n$ git clone git+https://github.com/cthoyt/autoreviewer.git\n$ cd autoreviewer\n$ pip install -e .\n```\n\n### \ud83e\udd7c Testing\n\nAfter cloning the repository and installing `tox` with `pip install tox`, the unit tests in the `tests/` folder can be\nrun reproducibly with:\n\n```shell\n$ tox\n```\n\nAdditionally, these tests are automatically re-run with each commit in\na [GitHub Action](https://github.com/cthoyt/autoreviewer/actions?query=workflow%3ATests).\n\n### \ud83d\udcd6 Building the Documentation\n\nThe documentation can be built locally using the following:\n\n```shell\n$ git clone git+https://github.com/cthoyt/autoreviewer.git\n$ cd autoreviewer\n$ tox -e docs\n$ open docs/build/html/index.html\n``` \n\nThe documentation automatically installs the package as well as the `docs`\nextra specified in the [`setup.cfg`](setup.cfg). `sphinx` plugins\nlike `texext` can be added there. Additionally, they need to be added to the\n`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).\n\n### \ud83d\udce6 Making a Release\n\nAfter installing the package in development mode and installing\n`tox` with `pip install tox`, the commands for making a new release are contained within the `finish` environment\nin `tox.ini`. Run the following from the shell:\n\n```shell\n$ tox -e finish\n```\n\nThis script does the following:\n\n1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the version number in the `setup.cfg`,\n `src/autoreviewer/version.py`, and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix\n2. Packages the code in both a tar archive and a wheel using [`build`](https://github.com/pypa/build)\n3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to have a `.pypirc` file configured to avoid\n the need for manual input at this\n step\n4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.\n5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can\n use `tox -e bumpversion minor` after.\n\n</details>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Automate scientific software review",
"version": "0.0.5",
"project_urls": {
"Bug Tracker": "https://github.com/cthoyt/autoreviewer/issues",
"Download": "https://github.com/cthoyt/autoreviewer/releases",
"Homepage": "https://github.com/cthoyt/autoreviewer",
"Source Code": "https://github.com/cthoyt/autoreviewer"
},
"split_keywords": [
"snekpack",
" cookiecutter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "986ee5750a773e9367e2f4dbff1183966c9b8e2d630c561f080a0978934cdd73",
"md5": "86005a827f115b4628943880a2c2fa50",
"sha256": "3f4d12562ad43950ef75c6774bc5350a1a806beda9ca425d37e765a5653809f8"
},
"downloads": -1,
"filename": "autoreviewer-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86005a827f115b4628943880a2c2fa50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 481091,
"upload_time": "2024-04-01T19:47:58",
"upload_time_iso_8601": "2024-04-01T19:47:58.738874Z",
"url": "https://files.pythonhosted.org/packages/98/6e/e5750a773e9367e2f4dbff1183966c9b8e2d630c561f080a0978934cdd73/autoreviewer-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8dfb2e763bef65a2f33138a87afa1fda2cb7674b823d010260c64d4affba0d28",
"md5": "07a124650732dffdbf962ff28c9ce1a4",
"sha256": "694ddff489aaddb64b20f2e1c0e06fed8bba42a6d4fd38f910aea002059981ae"
},
"downloads": -1,
"filename": "autoreviewer-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "07a124650732dffdbf962ff28c9ce1a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 316787,
"upload_time": "2024-04-01T19:48:01",
"upload_time_iso_8601": "2024-04-01T19:48:01.053459Z",
"url": "https://files.pythonhosted.org/packages/8d/fb/2e763bef65a2f33138a87afa1fda2cb7674b823d010260c64d4affba0d28/autoreviewer-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 19:48:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cthoyt",
"github_project": "autoreviewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "autoreviewer"
}
JSON
