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 <amit_sharma@live.com>

* installing dynamic versioning

Signed-off-by: Amit Sharma <amit_sharma@live.com>

---------

Signed-off-by: Amit Sharma <amit_sharma@live.com>
This commit is contained in:
Amit Sharma 2023-12-06 13:39:39 +05:30 коммит произвёл GitHub
Родитель e7bd2ad84f
Коммит e66ed36f1b
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 10 добавлений и 0 удалений

8
.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/notify-discord@v0.4.1

Просмотреть файл

@ -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.