From a53a6254523764d3738c02c19298198c9b526d87 Mon Sep 17 00:00:00 2001 From: Niels Vanspauwen Date: Fri, 16 Jun 2023 21:19:13 +0200 Subject: [PATCH] add build instructions --- BUILD.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 BUILD.md diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..de33be1 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,24 @@ +# Building from Source + +To build the package from source, follow these steps: + +``` +$ pip install -r requirements.txt +$ python setup.py sdist bdist_wheel +``` + +To test the package before uploading to PyPi: + +``` +$ python -m venv myenv +$ source myenv/bin/activate +$ pip install . +$ pystructurizr dev --view example.containerview +$ deactivate +$ rm -fr myenv +``` + +# Deploying to PyPi +``` +$ twine upload dist/* +```