.. image:: https://img.shields.io/pypi/v/structurizr-python.svg :target: https://pypi.org/project/structurizr-python/ :alt: Current PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/structurizr-python.svg :target: https://pypi.org/project/structurizr-python/ :alt: Supported Python Versions
.. image:: https://img.shields.io/pypi/l/structurizr-python.svg :target: https://www.apache.org/licenses/LICENSE-2.0 :alt: Apache Software License Version 2.0
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg :target: .github/CODE_OF_CONDUCT.md :alt: Code of Conduct
.. image:: https://github.com/Midnighter/structurizr-python/workflows/CI-CD/badge.svg :target: https://github.com/Midnighter/structurizr-python/workflows/CI-CD :alt: GitHub Actions
.. image:: https://codecov.io/gh/Midnighter/structurizr-python/branch/devel/graph/badge.svg :target: https://codecov.io/gh/Midnighter/structurizr-python :alt: Codecov
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Black
.. image:: https://readthedocs.org/projects/structurizr-python/badge/?version=latest :target: https://structurizr-python.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. summary-start
A Python client package for the Structurizr cloud service and on-premises installation.
Take Note: I realized that I rely more and more on the Structurizr DSL <https://structurizr.com/help/dsl>
and less on this Python client. Since this
is a hobby project and my time is limited, I decided that I will stop supporting
this package for now and put it into archive mode. If you depend on this
project, you can always install the last version from PyPI; and if you want to
pick up maintenance & development, please contact me by email or on the
Structurizr Slack #python <https://structurizr.slack.com/archives/CCH85LD2Q>
channel. I will be happy to introduce you to the codebase and assist in any way
I can.
The structurizr-python package is in active development and should be considered Alpha
software. Reports of problems are appreciated but please do not expect fully working
software at this point. If you want to get involved, you are most welcome as this is
a spare time project. Please write me an e-mail or on the
Structurizr Slack team <https://structurizr.com/help>
_ so that we can coordinate.
It's as simple as:
.. code-block:: console
pip install structurizr-python
Apache Software License 2.0 <https://www.apache.org/licenses/LICENSE-2.0>
_... summary-end