Navigation Menu

Skip to content

gaphor/gaphor

Repository files navigation

Gaphor - UML/SysML Modeling

Build Hypothesis Tests Docs build state PyPI PyPI - Downloads Matrix

Maintainability Test Coverage Translation Status Sourcery standard-readme compliant All Contributors.org

Gaphor is a UML and SysML modeling application written in Python. It is designed to be easy to use, while still being powerful. Gaphor implements a fully-compliant UML 2 data model, so it is much more than a picture drawing tool. You can use Gaphor to quickly visualize different aspects of a system as well as create complete, highly complex models.

Gaphor Demo

๐Ÿ“‘ Table of Contents

๐Ÿ“œ Background

Gaphor is a UML and SysML modeling application written in Python. We designed it to be easy to use, while still being powerful. Gaphor implements a fully-compliant UML 2 data model, so it is much more than a picture drawing tool. You can use Gaphor to quickly visualize different aspects of a system as well as create complete, highly complex models.

Gaphor is designed around the following principles:

  • Simplicity: The application should be easy to use. Only some basic knowledge of UML or SysML is required.
  • Consistency: UML is a graphical modeling language, so all modeling is done in a diagram.
  • Workability: The application should not bother the user every time they do something non-UML-ish.

Gaphor is a GUI application. It has a modern GTK-based interface and uses Cairo for consistent rendering.

Gaphor is a library. You can use it from scripts and Jupyter notebooks and interact with models programmatically.

Non-Goals:

  • Generating UML diagrams from source code. pynsource or pyreverse might be what you are looking for.
  • Generating source code from diagrams or creating other concrete executable artifacts including use of fUML or ALF.

Although it would be possible to incorporate these features, these aren't the goals of this project. However, if these are important capabilities for you, you may be able to extend Gaphor by creating a plugin.

๐Ÿ’พ Install

Download on Flathub

You can find the latest version on the gaphor.org website. Gaphor ships installers for macOS and Windows. Those can be found there. The Python package is also available on PyPI.

All releases are available on GitHub.

If you want to start developing on Gaphor, have a look at the Installation section of our documentation.

๐Ÿ”ฆ Usage

If using Gaphor for the first time you will be presented with a greeter dialog at startup in which you can select one of 5 models available to you to work in:

  • Generic: (or blank) template
  • UML: Unified Modeling Language template
  • SysML: Systems Modeling Language template
  • RAAML: Risk Analysis and Assessment Modeling language template
  • C4 Model: a lean graphical notation technique for modelling the architecture of software systems template

After you select a template, the main Gaphor window will load, and you will be ready to start modeling. Gaphor will automatically select the correct profile based on the template that you selected, but you can also select other modeling profiles if needed by clicking on the button next to the Profile dropdown menu at the top of your window.

To select an element you want to place, for example a Class, click on the icon in the Toolbox and then again on the diagram. This will place a new Class item on the diagram and add a new Class to the model (it shows up in the Model Browser).

Portions of the toolbox may also be collapsed depending on the type of diagram you are modeling with. You can expand the collapsed portions of the toolbox if needed.

If you want to know more, please read our documentation on https://docs.gaphor.org.

โ™ฅ Contributing

Thanks goes to these wonderful people (emoji key):

2old4it
2old4it

๐Ÿ›
2old4this
2old4this

๐Ÿ›
3fla1416
3fla1416

๐Ÿ›
Adam Bjurstrom
Adam Bjurstrom

๐Ÿ›
Adam Boduch
Adam Boduch

๐Ÿ’ป โš ๏ธ ๐Ÿ›
Alen ล iljak
Alen ล iljak

๐Ÿ›
Alexander Wilms
Alexander Wilms

๐Ÿ›
Alexis Howells
Alexis Howells

๐Ÿ“–
Amor Ali
Amor Ali

๐Ÿ›
Amy Y
Amy Y

๐ŸŒ
Andrei
Andrei

๐Ÿ›
Andrew
Andrew

๐Ÿ›
Antonio Mejia
Antonio Mejia

๐ŸŒ
Arjan Molenaar
Arjan Molenaar

๐Ÿ’ป ๐Ÿ› ๐Ÿ“– ๐Ÿ‘€ ๐Ÿ’ฌ ๐Ÿ› ๐Ÿ”Œ โš ๏ธ
Aurรฉlien Joga
Aurรฉlien Joga

๐Ÿ“–
Bill ZHANG
Bill ZHANG

๐ŸŒ
Bjรถrn Strรถmberg
Bjรถrn Strรถmberg

๐Ÿ›
Blippost
Blippost

๐Ÿค”
Brage Fuglseth
Brage Fuglseth

๐ŸŽจ
Brandan Glendenning
Brandan Glendenning

๐Ÿ“–
Brock Tibert
Brock Tibert

๐Ÿ›
Can Lehmann
Can Lehmann

๐Ÿ’ป
Christian Hoff
Christian Hoff

๐Ÿ’ป
DKX47
DKX47

๐Ÿ›
Dan Yeaw
Dan Yeaw

๐Ÿ’ป โš ๏ธ ๐Ÿ“– ๐Ÿ“ฆ ๐Ÿš‡ ๐Ÿ› ๐Ÿ’ฌ
Daniel Berglรธv
Daniel Berglรธv

๐Ÿค”
Daniel Nylander
Daniel Nylander

๐ŸŒ
DimShadoWWW
DimShadoWWW

๐Ÿ›
Douglas B
Douglas B

๐Ÿ“–
Encolpe DEGOUTE
Encolpe DEGOUTE

๐ŸŒ
Enno Grรถper
Enno Grรถper

๐Ÿ’ป
Enno Zickler
Enno Zickler

๐Ÿ›
Ercalvez
Ercalvez

๐ŸŒ
Erwan Bousse
Erwan Bousse

๐Ÿค” ๐Ÿ›
Eryk Michalak
Eryk Michalak

๐ŸŒ
Felipe Nogueira
Felipe Nogueira

๐ŸŒ
Fell-x27
Fell-x27

๐Ÿ›
Fran Diรฉguez
Fran Diรฉguez

๐ŸŒ
Francisco Gouveia
Francisco Gouveia

๐Ÿ’ป
Gabriel Gian
Gabriel Gian

๐ŸŒ
Gleb Smirnov
Gleb Smirnov

๐Ÿ›
Greg Stewart
Greg Stewart

๐Ÿ›
Gytree
Gytree

๐Ÿ›
Gรผnther Wagner
Gรผnther Wagner

๐Ÿ›
Hamish Mcintyre-Bhatty
Hamish Mcintyre-Bhatty

๐Ÿ›
HighKingofMelons
HighKingofMelons

๐Ÿ›
Igor Lerinc
Igor Lerinc

๐Ÿ›
Ikko Ashimine
Ikko Ashimine

๐Ÿ’ป
JACKADUX
JACKADUX

๐Ÿ›
Jacob Crabill
Jacob Crabill

๐Ÿ›
Jacobo Aragunde Pรฉrez
Jacobo Aragunde Pรฉrez

๐Ÿ›
Jan
Jan

๐Ÿ›
Jean-Luc Tibaux
Jean-Luc Tibaux

๐ŸŒ
JensPfeifle
JensPfeifle

๐Ÿ“–
Jonathan
Jonathan

๐Ÿค” ๐Ÿ› ๐ŸŒ ๐Ÿ’ป
Jonathan E. Magen
Jonathan E. Magen

๐Ÿค”
JonnathanRiquelmo
JonnathanRiquelmo

๐ŸŒ
Jordi Mallach
Jordi Mallach

๐ŸŒ
Jorge DLG
Jorge DLG

๐Ÿ›
Juha-Matti Kokkonen
Juha-Matti Kokkonen

๐Ÿ›
Julius Rรผberg
Julius Rรผberg

๐Ÿ›
JuliusBrueggemann
JuliusBrueggemann

๐Ÿ›
K.B.Dharun Krishna
K.B.Dharun Krishna

๐ŸŒ
Kapil Thangavelu
Kapil Thangavelu

๐Ÿ›
KhazAkar
KhazAkar

๐Ÿ›
Kian-Meng Ang
Kian-Meng Ang

๐Ÿ“–
Lazerbeak12345
Lazerbeak12345

๐Ÿ›
Lordy
Lordy

๐Ÿ›
Mark Kennedy
Mark Kennedy

๐Ÿค” ๐Ÿ’ป ๐Ÿ›
Mark-Daniel Lรผthje
Mark-Daniel Lรผthje

๐ŸŒ
Mat
Mat

๐Ÿ’ป
Matthew Maclaine
Matthew Maclaine

๐Ÿ›
Maxim
Maxim

๐Ÿ›
Mek101
Mek101

๐Ÿ›
Michael J. Vinca
Michael J. Vinca

๐Ÿ›
Michael Patrick Tkacik
Michael Patrick Tkacik

๐Ÿ›
Mikhail Bessonov
Mikhail Bessonov

๐Ÿ›
Mikkel Aunsbjerg Jakobsen
Mikkel Aunsbjerg Jakobsen

๐Ÿ›
Nedko Arnaudov
Nedko Arnaudov

๐Ÿ›
Patrik
Patrik

๐Ÿค”
Paul Menzel
Paul Menzel

๐Ÿ“–
Paweล‚ Pajฤ…k
Paweล‚ Pajฤ…k

๐Ÿ›
Petal
Petal

๐Ÿ“– ๐ŸŒ
Phil_Smurf
Phil_Smurf

๐Ÿค”
Philip Goto
Philip Goto

๐ŸŒ
Rafael Fontenelle
Rafael Fontenelle

๐ŸŒ ๐Ÿค”
Rafael Muรฑoz Cรกrdenas
Rafael Muรฑoz Cรกrdenas

๐Ÿ›
RenStone83
RenStone83

๐Ÿ›
Richard Bamford
Richard Bamford

๐Ÿ›
Rui Maciel
Rui Maciel

๐Ÿค”
Sabri รœnal
Sabri รœnal

๐ŸŒ ๐Ÿ’ป
Sascha Holzhauer
Sascha Holzhauer

๐Ÿ› ๐Ÿ“–
SebCanet
SebCanet

๐Ÿค”
Sebi
Sebi

๐Ÿ›
Seong-ho Cho
Seong-ho Cho

๐ŸŒ
Sergej A.
Sergej A.

๐ŸŒ
Sophie Herold
Sophie Herold

๐Ÿ’ป ๏ธ๏ธ๏ธ๏ธโ™ฟ๏ธ
Steve Kossouho
Steve Kossouho

๐Ÿ› ๐Ÿ’ป
Steven Liu
Steven Liu

๐Ÿ›
Sycophantic-Witty
Sycophantic-Witty

๐Ÿ›
Teun Hoevenaars
Teun Hoevenaars

๐Ÿ“–
Thomas
Thomas

๐Ÿ›
Thomas Firchau
Thomas Firchau

๐Ÿ“–
Tiemen Schuijbroek
Tiemen Schuijbroek

๐Ÿ› ๐Ÿ’ป
Tobias Bernard
Tobias Bernard

๐ŸŽจ ๐Ÿค”
TomBous
TomBous

๐Ÿ›
Tomasz Droลผdลผ
Tomasz Droลผdลผ

๐Ÿค”
Tony
Tony

๐Ÿšง
Viicos
Viicos

๐Ÿ›
Xander982
Xander982

๐Ÿ–‹ ๐Ÿ›
YantaoZhao
YantaoZhao

๐Ÿ› ๐Ÿค”
Yauhen Kirylau
Yauhen Kirylau

๐Ÿ“– ๐Ÿ“ฆ ๐Ÿค” ๐Ÿ›
Zsolt Sandor
Zsolt Sandor

๐Ÿค” ๐Ÿ› ๐Ÿ’ป ๐Ÿ“–
\s\m
\s\m

๐Ÿ“–
albanobattistella
albanobattistella

๐ŸŒ
bayerl
bayerl

๐Ÿ“–
cloud-erik
cloud-erik

๐Ÿค”
deifemu
deifemu

๐Ÿ›
freddii
freddii

๐Ÿค” ๐Ÿ“–
freezed-or-frozen
freezed-or-frozen

๐Ÿ›
fu7mu4
fu7mu4

๐ŸŒ
gavr123456789
gavr123456789

๐Ÿค”
ghillebrand
ghillebrand

๐Ÿค”
greedyj4ck
greedyj4ck

๐Ÿ›
johnvon
johnvon

๐ŸŒ
jposada202020
jposada202020

๐ŸŒ
kellenmoura
kellenmoura

๐Ÿ›
lightonflux
lightonflux

๐Ÿ›
lukman83
lukman83

๐Ÿ›
madiharvey
madiharvey

๐Ÿค” ๐Ÿ›
mcdigregorio
mcdigregorio

๐Ÿ›
melisdogan
melisdogan

๐Ÿ“–
mikekidner
mikekidner

๐Ÿ› ๐Ÿ’ป
milotype
milotype

๐ŸŒ ๐Ÿ“–
mskorkowski
mskorkowski

๐Ÿ›
noblevirk
noblevirk

๐Ÿค”
nomisge
nomisge

๐Ÿ› ๐Ÿค”
ovari
ovari

๐Ÿค” ๐ŸŒ ๐Ÿ›
perovsek
perovsek

๐ŸŒ ๐Ÿ›
peter88213
peter88213

๐Ÿ›
qsodev
qsodev

๐Ÿ›
samirodj
samirodj

๐Ÿ›
seryafarma
seryafarma

๐Ÿ“–
shobeira
shobeira

๐Ÿ› ๐Ÿค”
sib@c
sib@c

๐Ÿ› ๐Ÿค”
tompkins-ct
tompkins-ct

๐Ÿ› ๐Ÿค”
tronta
tronta

๐Ÿ›
vikdevelop
vikdevelop

๐ŸŒ
wrobell
wrobell

๐Ÿ’ป โš ๏ธ ๐Ÿ› ๐ŸŽจ
zhangxinqiang
zhangxinqiang

๐ŸŒ
ร“scar Fernรกndez Dรญaz
ร“scar Fernรกndez Dรญaz

๐ŸŒ ๐Ÿ’ป
ะ•ะฒะณะตะฝะธะน ะ›ะตะถะฝะธะฝ
ะ•ะฒะณะตะฝะธะน ะ›ะตะถะฝะธะฝ

๐ŸŒ
ะŸั‘ั‚ั€ ะกะฐะฑะฐะฝะพะฒ
ะŸั‘ั‚ั€ ะกะฐะฑะฐะฝะพะฒ

๐ŸŒ
ๅ“้›ช
ๅ“้›ช

๐Ÿ›

This project follows the all-contributors specification. Contributions of any kind are welcome!

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a first-timers-only tag for issues that should be ideal for people who are not very familiar with the codebase yet.
  2. Fork the repository on GitHub to start making your changes to the main branch (or branch off of it).
  3. Write a test which shows that the bug was fixed or that the feature works as expected.
  4. Send a pull request and bug the maintainers until it gets merged and published. ๐Ÿ˜„

See the contributing guide!

๐ŸŒ Translations

Translation of Gaphor is mostly done using Weblate.

For the Linux Flatpak, the desktop entry comment string can be translated at our Flatpak repository.

Thank you so much for your effort in helping us keep it available in many languages!

Translation status

โ™ฟ๏ธ Code of Conduct

We value your participation and want everyone to have an enjoyable and fulfilling experience. As a GNOME Circle project, all participants are expected to follow the GNOME Code of Conduct and to show respect, understanding, and consideration to one another. Thank you for helping make this a welcoming, friendly community for everyone.

ยฉ๏ธ License

Copyright ยฉ The Gaphor Development Team

Licensed under the Apache License v2.

Summary: You can do what you like with Gaphor, as long as you include the required notices. This permissive license contains a patent license from the contributors of the code.