Skip to main content

Gaphor is the simple modeling tool written in Python.

Project description

Gaphor - UML/SysML Modeling

Build Hypothesis Tests Docs build state PyPI PyPI - Downloads Matrix

Maintainability Test Coverage Translation Status Sourcery Code style: black standard-readme compliant All Contributors

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 that is built on GTK and Cairo. PyGObject and PyCairo provide Python bindings for those libraries. Gaphas provides the foundational diagramming functionality.

๐Ÿ’พ Install

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 Tech docs.

๐Ÿ”ฆ Usage

Creating models

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 Navigation). The selected tool will reset itself to the Pointer tool if the option ''Diagram -> Reset tool'' is selected.

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.

Create a New Diagram

  1. Use the Navigation to select an element that can contain a diagram (a Package or Profile)
  2. Select the New diagram button in the upper left and select the type of diagram you would like to create from the dropdown.

It is also possible to create a new diagram by right clicking on a Package or Profile in the Navigation and selecting New Diagram.

Copy and Paste

Items in a diagram can be copied and pasted in the same diagram or other diagrams.

Ctrl+V: The default way to paste uses a link defining elements mode. This places an existing item in the diagram, but the item itself is not duplicated. In other words, if you paste a Class object in a diagram, the Class will be added to the diagram, but there will be no new Class in the Navigation.

Shift+Ctrl+V: Copy defining elements. This places a new item in the model by fully duplicating the item that was copied.

Drag and Drop

Adding an existing element to a diagram is done by dragging the element from the Navigation section onto a diagram. Diagrams and attribute/operations of a Class show up in the Navigation but can not be added to a diagram.

Elements can also be dragged within the Navigation in order to rearrange them in to different packages.

โ™ฅ Contributing

Thanks goes to these wonderful people (emoji key):

Adam Bjurstrom
Adam Bjurstrom

๐Ÿ›
Adam Boduch
Adam Boduch

๐Ÿ’ป โš ๏ธ ๐Ÿ›
Alexander Wilms
Alexander Wilms

๐Ÿ›
Alexis Howells
Alexis Howells

๐Ÿ“–
Amy Y
Amy Y

๐ŸŒ
Andrew
Andrew

๐Ÿ›
Arjan Molenaar
Arjan Molenaar

๐Ÿ’ป ๐Ÿ› ๐Ÿ“– ๐Ÿ‘€ ๐Ÿ’ฌ ๐Ÿ› ๐Ÿ”Œ โš ๏ธ
Bill ZHANG
Bill ZHANG

๐ŸŒ
Blippost
Blippost

๐Ÿค”
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

๐Ÿ›
Erwan Bousse
Erwan Bousse

๐Ÿค” ๐Ÿ›
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

๐Ÿ›
Ikko Ashimine
Ikko Ashimine

๐Ÿ’ป
Jacob Crabill
Jacob Crabill

๐Ÿ›
Jan
Jan

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

๐Ÿ›
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 Patrick Tkacik
Michael Patrick Tkacik

๐Ÿ›
Mikhail Bessonov
Mikhail Bessonov

๐Ÿ›
Nedko Arnaudov
Nedko Arnaudov

๐Ÿ›
Phil_Smurf
Phil_Smurf

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

๐Ÿ›
RenStone83
RenStone83

๐Ÿ›
Rui Maciel
Rui Maciel

๐Ÿค”
Sascha Holzhauer
Sascha Holzhauer

๐Ÿ›
Sebi
Sebi

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

๐ŸŒ
Steve Kossouho
Steve Kossouho

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

๐Ÿ›
Thomas
Thomas

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

๐Ÿค” ๐Ÿ› ๐Ÿ’ป ๐Ÿ“–
albanobattistella
albanobattistella

๐ŸŒ
deifemu
deifemu

๐Ÿ›
freddii
freddii

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

๐Ÿ›
fu7mu4
fu7mu4

๐ŸŒ
gavr123456789
gavr123456789

๐Ÿค”
greedyj4ck
greedyj4ck

๐Ÿ›
kellenmoura
kellenmoura

๐Ÿ›
lukman83
lukman83

๐Ÿ›
melisdogan
melisdogan

๐Ÿ“–
milotype
milotype

๐ŸŒ ๐Ÿ“–
mskorkowski
mskorkowski

๐Ÿ›
noblevirk
noblevirk

๐Ÿค”
nomisge
nomisge

๐Ÿ›
ovari
ovari

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

๐ŸŒ ๐Ÿ›
qsodev
qsodev

๐Ÿ›
samirodj
samirodj

๐Ÿ›
seryafarma
seryafarma

๐Ÿ“–
sib@c
sib@c

๐Ÿ› ๐Ÿค”
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 file!

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!

ยฉ License

Copyright ยฉ Arjan Molenaar and Dan Yeaw

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gaphor-2.13.0.tar.gz (543.1 kB view hashes)

Uploaded source

Built Distribution

gaphor-2.13.0-py3-none-any.whl (781.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page