gaphor

Gaphor is the simple modeling tool

Stars
1.54K
Forks
174
Open issues
126
Closed issues
575
Last release
4 months ago
Last commit
4 months ago
Watchers
1.54K
Total releases
57
Total commits
10.9K
Open PRs
10
Closed PRs
2.04K
Repo URL
Platform
Mac
License
apache-2.0
Category
Usecase
Graphics
Offers premium version?
NO
Proprietary?
NO
About

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.

πŸ“‘ Table of Contents

  • πŸ“‘ Table of Contents
  • πŸ“œ Background
  • πŸ’Ύ Install
  • πŸ”¦ Usage
  • β™₯ Contributing
    • 🌍 Translations
    • ♿️ Code of Conduct

  • ©️ License
πŸ“œ 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

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

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.

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

πŸ›


2old4this

πŸ›


3fla1416

πŸ›


Adam Bjurstrom

πŸ›


Adam Boduch

πŸ’» ⚠️ πŸ›


Alen Ε iljak

πŸ›


Alexander Wilms

πŸ›


Alexis Howells

πŸ“–


Amor Ali

πŸ›


Amy Y

🌍


Andrei

πŸ›


Andrew

πŸ›


Arjan Molenaar

πŸ’» πŸ› πŸ“– πŸ‘€ πŸ’¬ πŸ› πŸ”Œ ⚠️


AurΓ©lien Joga

πŸ“–


Bill ZHANG

🌍


Blippost

πŸ€”


Brandan Glendenning

πŸ“–


Brock Tibert

πŸ›


Can Lehmann

πŸ’»


Christian Hoff

πŸ’»


DKX47

πŸ›


Dan Yeaw

πŸ’» ⚠️ πŸ“– πŸ“¦ πŸš‡ πŸ› πŸ’¬


Daniel BerglΓΈv

πŸ€”


Daniel Nylander

🌍


DimShadoWWW

πŸ›


Douglas B

πŸ“–


Encolpe DEGOUTE

🌍


Enno GrΓΆper

πŸ’»


Enno Zickler

πŸ›


Ercalvez

🌍


Erwan Bousse

πŸ€” πŸ›


Eryk Michalak

🌍


Felipe Nogueira

🌍


Fell-x27

πŸ›


Fran DiΓ©guez

🌍


Gabriel Gian

🌍


Gleb Smirnov

πŸ›


Greg Stewart

πŸ›


Gytree

πŸ›


GΓΌnther Wagner

πŸ›


Hamish Mcintyre-Bhatty

πŸ›


HighKingofMelons

πŸ›


Igor Lerinc

πŸ›


Ikko Ashimine

πŸ’»


Jacob Crabill

πŸ›


Jan

πŸ›


Jean-Luc Tibaux

🌍


JensPfeifle

πŸ“–


Jonathan

πŸ€” πŸ› 🌍 πŸ’»


Jonathan E. Magen

πŸ€”


JonnathanRiquelmo

🌍


Jordi Mallach

🌍


Jorge DLG

πŸ›


Juha-Matti Kokkonen

πŸ›


Julius RΓΌberg

πŸ›


JuliusBrueggemann

πŸ›


K.B.Dharun Krishna

🌍


Kapil Thangavelu

πŸ›


KhazAkar

πŸ›


Kian-Meng Ang

πŸ“–


Lazerbeak12345

πŸ›


Lordy

πŸ›


Mark Kennedy

πŸ€” πŸ’» πŸ›


Mark-Daniel LΓΌthje

🌍


Mat

πŸ’»


Matthew Maclaine

πŸ›


Maxim

πŸ›


Mek101

πŸ›


Michael Patrick Tkacik

πŸ›


Mikhail Bessonov

πŸ›


Mikkel Aunsbjerg Jakobsen

πŸ›


Nedko Arnaudov

πŸ›


Patrik

πŸ€”


PaweΕ‚ PajΔ…k

πŸ›


Phil_Smurf

πŸ€”


Philip Goto

🌍


Rafael MuΓ±oz CΓ‘rdenas

πŸ›


RenStone83

πŸ›


Richard Bamford

πŸ›


Rui Maciel

πŸ€”


Sabri Ünal

🌍 πŸ’»


Sascha Holzhauer

πŸ› πŸ“–


SebCanet

πŸ€”


Sebi

πŸ›


Seong-ho Cho

🌍


Sergej A.

🌍


Sophie Herold

πŸ’» ️️️️♿️


Steve Kossouho

πŸ› πŸ’»


Steven Liu

πŸ›


Sycophantic-Witty

πŸ›


Thomas

πŸ›


Thomas Firchau

πŸ“–


Tiemen Schuijbroek

πŸ› πŸ’»


Tobias Bernard

🎨 πŸ€”


TomBous

πŸ›


Tomasz DroΕΌdΕΌ

πŸ€”


Tony

🚧


Viicos

πŸ›


Xander982

πŸ–‹ πŸ›


YantaoZhao

πŸ› πŸ€”


Yauhen Kirylau

πŸ“– πŸ“¦ πŸ€” πŸ›


Zsolt Sandor

πŸ€” πŸ› πŸ’» πŸ“–


albanobattistella

🌍


cloud-erik

πŸ€”


deifemu

πŸ›


freddii

πŸ€” πŸ“–


freezed-or-frozen

πŸ›


fu7mu4

🌍


gavr123456789

πŸ€”


ghillebrand

πŸ€”


greedyj4ck

πŸ›


johnvon

🌍


jposada202020

🌍


kellenmoura

πŸ›


lightonflux

πŸ›


lukman83

πŸ›


madiharvey

πŸ€” πŸ›


mcdigregorio

πŸ›


melisdogan

πŸ“–


mikekidner

πŸ› πŸ’»


milotype

🌍 πŸ“–


mskorkowski

πŸ›


noblevirk

πŸ€”


nomisge

πŸ›


ovari

πŸ€” 🌍 πŸ›


perovsek

🌍 πŸ›


peter88213

πŸ›


qsodev

πŸ›


samirodj

πŸ›


seryafarma

πŸ“–


shobeira

πŸ›


sib@c

πŸ› πŸ€”


tompkins-ct

πŸ›


tronta

πŸ›


vikdevelop

🌍


wrobell

πŸ’» ⚠️ πŸ› 🎨


Γ“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!

♿️ 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 Β© 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.

Alternative Projects

Subscribe to Open Source Businees Newsletter

Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.

We'll never share your email with anyone else.