Add new shields and PyPI install option. (#4)

Author: tobiasraabe

.github/workflows/continuous-integration-workflow.yml

@@ -54,15 +54,6 @@ jobs:
         shell: bash -l {0}
         run: bash <(curl -s https://codecov.io/bash) -F unit -c
 
-      # - name: Run integration tests.
-      #   shell: bash -l {0}
-      #   run: tox -e pytest -- src tests -m integration --cov=./ --cov-report=xml -n auto
-
-      # - name: Upload coverage reports of integration tests.
-      #   if: runner.os == 'Linux' && matrix.python-version == '3.8'
-      #   shell: bash -l {0}
-      #   run: bash <(curl -s https://codecov.io/bash) -F integration -c
-
       - name: Run end-to-end tests.
         shell: bash -l {0}
         run: tox -e pytest -- src tests -m end_to_end --cov=./ --cov-report=xml -n auto

CHANGES.rst

@@ -3,10 +3,17 @@ Changes
 
 This is a record of all past latex-dependency-scanner releases and what went into them
 in reverse chronological order. Releases follow `semantic versioning
-<https://semver.org/>`_ and all releases are available on `Anaconda.org
+<https://semver.org/>`_ and all releases are available on `PyPI
+<https://pypi.org/project/latex-dependency-scanner>`_ and `Anaconda.org
 <https://anaconda.org/pytask/latex-dependency-scanner>`_.
 
 
+0.0.3 - 2021-xx-xx
+------------------
+
+- :gh:`4` adds the PyPI install option to the README and more shields.
+
+
 0.0.2 - 2021-02-24
 ------------------
 

README.rst

@@ -1,11 +1,19 @@
+.. image:: https://img.shields.io/pypi/v/latex-dependency-scanner?color=blue
+    :alt: PyPI
+    :target: https://pypi.org/project/latex-dependency-scanner
+
+.. image:: https://img.shields.io/pypi/pyversions/latex-dependency-scanner
+    :alt: PyPI - Python Version
+    :target: https://pypi.org/project/latex-dependency-scanner
+
 .. image:: https://anaconda.org/pytask/latex-dependency-scanner/badges/version.svg
     :target: https://anaconda.org/pytask/latex-dependency-scanner
 
 .. image:: https://anaconda.org/pytask/latex-dependency-scanner/badges/platforms.svg
     :target: https://anaconda.org/pytask/latex-dependency-scanner
 
-.. .. image:: https://readthedocs.org/projects/pytask-dev/badge/?version=latest
-..     :target: https://pytask-dev.readthedocs.io/en/latest
+.. image:: https://img.shields.io/pypi/l/latex-dependency-scanner
+    :alt: PyPI - License
 
 .. image:: https://github.com/pytask-dev/latex-dependency-scanner/workflows/Continuous%20Integration%20Workflow/badge.svg?branch=main
     :target: https://github.com/pytask-dev/latex-dependency-scanner/actions?query=branch%3Amain
@@ -24,18 +32,23 @@
 Features
 --------
 
-The latex-dependency-scanner is a package to detect all related files of a LaTeX
+latex-dependency-scanner is a package to detect all required files to compile a LaTeX
 document.
 
 
 Installation
 ------------
 
-latex-dependency-scanner is available on `Anaconda.org
-<https://anaconda.org/pytask/latex-dependency-scanner>`_. Install the package with
+latex-dependency-scanner is available on `PyPI
+<https://pypi.org/project/latex-dependency-scanner>`_ and `Anaconda.org
+<https://anaconda.org/pytask/latex-dependency-scanner>`_. Install it with
 
 .. code-block:: console
 
+    $ pip install latex-dependency-scanner
+
+    # or
+
     $ conda config --add channels conda-forge --add channels pytask
     $ conda install latex-dependency-scanner
 

setup.py

@@ -1,16 +1,33 @@
+from pathlib import Path
+
 from setuptools import find_packages
 from setuptools import setup
 
 import versioneer
 
+README = Path("README.rst").read_text()
+
+PROJECT_URLS = {
+    "Documentation": "https://github.com/pytask-dev/latex-dependency-scanner",
+    "Github": "https://github.com/pytask-dev/latex-dependency-scanner",
+    "Tracker": "https://github.com/pytask-dev/latex-dependency-scanner/issues",
+    "Changelog": "https://github.com/pytask-dev/latex-dependency-scanner/blob/main/"
+    "CHANGES.rst",
+}
+
+
 setup(
     name="latex-dependency-scanner",
     version=versioneer.get_version(),
     cmdclass=versioneer.get_cmdclass(),
     description="Scan LaTeX documents for their dependencies.",
+    long_description=README,
+    long_description_content_type="text/x-rst",
     author="Tobias Raabe",
     author_email="[email protected]",
     python_requires=">=3.6",
+    url=PROJECT_URLS["Github"],
+    project_urls=PROJECT_URLS,
     license="MIT",
     classifiers=[
         "Development Status :: 3 - Alpha",