diff --git a/.github/workflows/pages.yaml b/.github/workflows/main.yaml similarity index 100% rename from .github/workflows/pages.yaml rename to .github/workflows/main.yaml diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index fc566f3..bfc3469 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -41,4 +41,4 @@ jobs: - name: e2e test run: | python pyarch.py -i fixtures -o fixtures - if [ $(cat fixtures/index.html | wc -l) -lt 150 ]; then echo "faulty html generated" && exit 1; fi + if [ $(cat fixtures/index.html | wc -l) -lt 150 ]; then echo "faulty html generated" && exit 1; fi diff --git a/README.md b/README.md index 2a37c02..51ecea2 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -# python-pkg-architecture +# pyarch The tool to visualise architecture of the python package. **The objective**: to facilitate understanding of the architecture of virtually any python package. -**The motivation**: +**The motivation**: + 1. Context load reduction when learning the structure of the python package. 2. Package architecture bottlenecks identification through inter-modules dependencies analysis. -## How to use +## Demo -TBD +- [SuperDuperDB](/superduperdb): the solution to bring AI to your database, + see [details](https://github.com/SuperDuperDB/superduperdb). ## Distribution and contribution