Gaphor Save

Gaphor is the simple modeling tool

Project README

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

πŸ›
Arjan Molenaar
Arjan Molenaar

πŸ’» πŸ› πŸ“– πŸ‘€ πŸ’¬ πŸ› πŸ”Œ ⚠️
AurΓ©lien Joga
AurΓ©lien Joga

πŸ“–
Bill ZHANG
Bill ZHANG

🌍
BjΓΆrn StrΓΆmberg
BjΓΆrn StrΓΆmberg

πŸ›
Blippost
Blippost

πŸ€”
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

🌍
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

πŸ’»
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

πŸ›
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

πŸ’» ⚠️ πŸ› 🎨
Γ“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. :smile:

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.

Open Source Agenda is not affiliated with "Gaphor" Project. README Source: gaphor/gaphor
Stars
1,659
Open Issues
108
Last Commit
1 week ago
Repository
License

Open Source Agenda Badge

Open Source Agenda Rating