Midnighter / structurizr-python

A Python 3 port of Simon Brown's Structurizr diagrams-as-code architecture description tool.
https://structurizr.com/
Apache License 2.0
65 stars 16 forks source link

Add loads(), dump() and dumps() to Workspace for import/export. #49

Closed yt-ms closed 3 years ago

yt-ms commented 3 years ago

Add dump(), dumps() and loads() to Workspace to make it easier to work with import/export outside of Structurizr. Opted not to go for an example as @mrchrisadams is looking to do this in readme.rst, which is probably better.


THIS SOFTWARE IS CONTRIBUTED SUBJECT TO THE TERMS OF THE Apache License v.2.0. YOU MAY OBTAIN A COPY OF THE LICENSE AT https://www.apache.org/licenses/LICENSE-2.0.

THIS SOFTWARE IS LICENSED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE MAY BE REDISTRIBUTED TO OTHERS ONLY BY EFFECTIVELY USING THIS OR ANOTHER EQUIVALENT DISCLAIMER IN ADDITION TO ANY OTHER REQUIRED LICENSE TERMS

codecov-io commented 3 years ago

Codecov Report

Merging #49 into devel will increase coverage by 0.19%. The diff coverage is 92.30%.

Impacted file tree graph

@@            Coverage Diff             @@
##            devel      #49      +/-   ##
==========================================
+ Coverage   85.10%   85.29%   +0.19%     
==========================================
  Files          64       64              
  Lines        1745     1755      +10     
  Branches      151      151              
==========================================
+ Hits         1485     1497      +12     
+ Misses        228      227       -1     
+ Partials       32       31       -1     
Impacted Files Coverage Δ
src/structurizr/api/structurizr_client.py 77.86% <0.00%> (ø)
src/structurizr/workspace.py 100.00% <100.00%> (+3.44%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3732199...1ce6b82. Read the comment docs.