Skip to content

Commit

Permalink
Merge branch 'auto-generated'
Browse files Browse the repository at this point in the history
  • Loading branch information
boromir674 committed Feb 20, 2024
2 parents 28d017b + 80210f3 commit bdcaa3e
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 156 deletions.
123 changes: 0 additions & 123 deletions .github/workflows/policy_docs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion CHANGELOG.rst
Expand Up @@ -2,7 +2,7 @@
Changelog
=========

0.0.1 (2024-02-19)
0.0.1 (2024-02-20)
=======================================

| This is the first ever release of the **biskotaki** Python Package.
Expand Down
13 changes: 0 additions & 13 deletions docs/cicd_mermaid.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/dockerfile_mermaid.md

This file was deleted.

18 changes: 9 additions & 9 deletions tox.ini
Expand Up @@ -402,22 +402,22 @@ commands_post =
[testenv:pydeps]
description = Visualise the dependency graphs (roughly which module imports which), by examining the
Python code. The dependency graph(s) are rendered in .svg file(s) and saved on the disk. By default, the generated
files are stored in the 'pydoer-graphs' directory, inside the project's root folder. You can use the PYDOER_GRAPHS
files are stored in the 'pydoer-graphs' directory, inside the project's root folder. You can use the PYDEPS_DIR
environment variable to determine the directory location to store the files. If the directory does not exist
it gets created. Requires that the 'dot' executable is in your PATH. Installing the graphviz library should make
the dot executable available in your PATH. Installing 'graphviz':
* For Linux users using Debian-based distributions (ie Ubuntu, Debian, Mint), please run "sudo apt install graphviz"
* For MacOS users with Homebrew, please run "brew install graphviz"
basepython = {env:TOXPYTHON:python3.8}
basepython = {env:TOXPYTHON:python3}
passenv =
HOME
PYDOER_GRAPHS
PYDEPS_DIR
deps =
pydeps==1.9.13
usedevelop = true
changedir = {toxinidir}
commands_pre =
python -c 'import os; p = "{env:PYDOER_GRAPHS:pydoer-graphs}"; exec("if not os.path.exists(p):\n os.mkdir(p)");'
python -c 'import os; p = "{env:PYDEPS_DIR:pydoer-graphs}"; exec("if not os.path.exists(p):\n os.mkdir(p)");'
commands =
pydeps --version

Expand All @@ -430,18 +430,18 @@ commands =
# --keep-target-cluster : draw target module as a cluster

# Draw only the source code package inner dependencies
pydeps src{/}{env:PY_PACKAGE} --only {env:PY_PACKAGE} --noshow -o {env:PYDOER_GRAPHS:pydoer-graphs}{/}deps_inner.svg
pydeps src{/}{env:PY_PACKAGE} --only {env:PY_PACKAGE} --noshow -o {env:PYDEPS_DIR:pydoer-graphs}{/}deps_inner.svg
# Draw the source code package inner and external dependencies
pydeps src{/}{env:PY_PACKAGE} --cluster --noshow -o {env:PYDOER_GRAPHS:pydoer-graphs}{/}deps_all.svg
pydeps src{/}{env:PY_PACKAGE} --cluster --noshow -o {env:PYDEPS_DIR:pydoer-graphs}{/}deps_all.svg

# Visualize the package inner dependencies and abstract the external (eg with numpy, pandas, etc) ones
# Draw the source code package inner and minimum external dependencies
pydeps src{/}{env:PY_PACKAGE} --max-cluster-size=2 --keep-target-cluster --noshow -o {env:PYDOER_GRAPHS:pydoer-graphs}{/}deps_ktc-mcs_2.svg
pydeps src{/}{env:PY_PACKAGE} --max-cluster-size=2 --keep-target-cluster --noshow -o {env:PYDEPS_DIR:pydoer-graphs}{/}deps_ktc-mcs_2.svg

# Draw the source code package inner and all external dependencies
pydeps src{/}{env:PY_PACKAGE} --keep-target-cluster --noshow -o {env:PYDOER_GRAPHS:pydoer-graphs}{/}deps_ktc.svg
pydeps src{/}{env:PY_PACKAGE} --keep-target-cluster --noshow -o {env:PYDEPS_DIR:pydoer-graphs}{/}deps_ktc.svg

python -c 'import os; print("\nGenerated dependency graph(s), as .svg files."); print("The graph(s) reside in the \"" + os.path.join("{toxinidir}", "{env:PYDOER_GRAPHS:pydoer-graphs}") + "\" directory and you can now view them ie in your browser.\n")'
python -c 'import os; print("\nGenerated dependency graph(s), as .svg files."); print("The graph(s) reside in the \"" + os.path.join("{toxinidir}", "{env:PYDEPS_DIR:pydoer-graphs}") + "\" directory and you can now view them ie in your browser.\n")'


[testenv:dev-env]
Expand Down

0 comments on commit bdcaa3e

Please sign in to comment.