diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..4dfd3b4 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,32 @@ +name: Release + +on: + release: + types: [published] + +permissions: + contents: read + id-token: write + +jobs: + release: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + + - name: Set up Python + uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 + with: + python-version: "3.x" + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + + - name: Build package + run: python -m build + + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0 diff --git a/README.md b/README.md index 20f3dd7..cf3af8d 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Analyzes IEEE, SIAM, ACM, and Springer format bibliographies for correctness. T Note: the arXiv API does not allow for checking against previous versions of papers. **If either the title or authors fail to match against an arXiv paper, make sure to manually check previous versions.** ## Installing BibChecker -The bibcheck package can be installed with pip. To install, run the following from the outermost directory: +The bibcheck package can be installed with pip. To install the latest release, run the following: -`pip install .` +`pip install bibchecker` ## Checking Citations in a PDF After installing, you can check the accuracy of citations in a PDF through `bibcheck filename.pdf` diff --git a/pyproject.toml b/pyproject.toml index cfab9bf..8893863 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"] build-backend = "setuptools.build_meta" [project] -name = "bibcheck" +name = "bibchecker" version = "0.1.0" description = "A tool for checking the accuracy of citations within an ACM, SIAM, or IEEE formatted bibliography." authors = [