Merge pull request #5 from Richardk2n/enforece-uploadability

assure the upload will work

Author: Richardk2n

.github/workflows/python-package.yml

@@ -10,7 +10,7 @@ on:
     branches: [ master ]
 
 jobs:
-  build:
+  testCode:
 
     runs-on: ubuntu-latest
     strategy:
@@ -41,3 +41,26 @@ jobs:
     - name: Test with pytest
       run: |
         pytest
+
+  testUploadability:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Test with rstcheck
+      run: |
+        rstcheck README.rst
+    - name: Build and check
+      run: |
+        python setup.py sdist bdist_wheel
+        twine check dist/*

.pre-commit-config.yaml

@@ -2,6 +2,10 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/psf/black
-    rev: 21.5b1
+    rev: 21.6b0
     hooks:
       - id: black
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-markup
+    rev: v1.0.1
+    hooks:
+      - id: rst-linter

README.rst

@@ -65,6 +65,8 @@ Install development dependencies with (you might want to create a virtualenv fir
 
 The project is formatted with `black`_. You can either configure your IDE to automatically format code with it, run it manually (``black .``) or rely on pre-commit (see below) to format files on git commit.
 
+The project uses two rst tests in order to assure uploadability to pipy: `rst-linter`_ as a pre-commit hook and `rstcheck`_ in a GitHub workflow. This does not catch all errors.
+
 This project uses `pre-commit`_ to enforce code-quality. After cloning the repository install the pre-commit hooks with:
 
 ::
@@ -74,5 +76,7 @@ This project uses `pre-commit`_ to enforce code-quality. After cloning the repos
 After that pre-commit will run `all defined hooks`_ on every ``git commit`` and keep you from committing if there are any errors.
 
 .. _black: https://github.com/psf/black
+.. _rst-linter: https://github.com/Lucas-C/pre-commit-hooks-markup
+.. _rstcheck: https://github.com/myint/rstcheck
 .. _pre-commit: https://pre-commit.com/
 .. _all defined hooks: .pre-commit-config.yaml

requirements.txt

@@ -2,3 +2,4 @@ python-lsp-server
 mypy
 black
 pre-commit
+rstcheck

setup.py

@@ -3,4 +3,4 @@
 from mypy_ls import _version
 
 if __name__ == "__main__":
-    setup(version=_version.__version__)
+    setup(version=_version.__version__, long_description_content_type="text/x-rst")