Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Midnighter/structurizr-python
A Python 3 port of Simon Brown's Structurizr diagrams-as-code architecture description tool.
https://github.com/Midnighter/structurizr-python
c4-model diagrams-as-code software-architecture structurizr structurizr-api
Last synced: 3 months ago
JSON representation
A Python 3 port of Simon Brown's Structurizr diagrams-as-code architecture description tool.
- Host: GitHub
- URL: https://github.com/Midnighter/structurizr-python
- Owner: Midnighter
- License: apache-2.0
- Archived: true
- Created: 2018-08-15T19:35:01.000Z (about 6 years ago)
- Default Branch: devel
- Last Pushed: 2023-01-21T10:13:16.000Z (almost 2 years ago)
- Last Synced: 2024-07-14T12:36:13.053Z (4 months ago)
- Topics: c4-model, diagrams-as-code, software-architecture, structurizr, structurizr-api
- Language: Python
- Homepage: https://structurizr.com/
- Size: 598 KB
- Stars: 65
- Watchers: 10
- Forks: 16
- Open Issues: 18
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: .github/CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - Midnighter/structurizr-python - A Python 3 port of Simon Brown's Structurizr diagrams-as-code architecture description tool. (others)
README
=============================
Structurizr for Python
=============================
.. 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.
Archive Mode
============
**Take Note:** I realized that I rely more and more on the `Structurizr 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 `_
channel. I will be happy to introduce you to the codebase and assist in any way
I can.
Warning
=======
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 `_ so that we can coordinate.
Install
=======
It's as simple as:
.. code-block:: console
pip install structurizr-python
Copyright
=========
* Copyright © 2020, Moritz E. Beber.
* Free software distributed under the `Apache Software License 2.0
`_.
.. summary-end