Fix errors in README and add a test to avoid such errors in the future (

#1103) * fixing pypi readme errors and adding a test Signed-off-by: Amit Sharma <[email protected]> * installing dynamic versioning Signed-off-by: Amit Sharma <[email protected]> --------- Signed-off-by: Amit Sharma <[email protected]>
py-why · Dec 6, 2023 · e66ed36 · e66ed36
1 parent e7bd2ad
commit e66ed36
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -70,6 +70,14 @@ jobs:
     - name: Test EconML based functionality
       run: poetry run poe test_econml
 
+    - name: Test README errors for PyPI
+      run: |
+          pip install poetry-dynamic-versioning
+          pip install twine
+          poetry-dynamic-versioning
+          poetry build
+          twine check dist/*
+
     - name: Notify Discord
       if: failure() && github.ref == 'refs/heads/main'
       uses: th0th/[email protected]

diff --git a/README.rst b/README.rst
@@ -102,8 +102,10 @@ If you face "Solving environment" problems with conda, then try :code:`conda upd
 If you prefer to use the latest dev version, your dependency management tool will need to point at our GitHub repository.
 
 .. code:: shell
+
     pip install git+https://github.com/py-why/dowhy@main
 
+
 **Requirements**
 
 DoWhy requires a few dependencies.