Skip to main content

Gaphor is the simple modeling tool written in Python.

Project description

Gaphor - UML/SysML Modeling

Build Docs build state 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

Once Gaphor is started a new empty model is automatically created. The main diagram is already open in the Diagram section.

Select an element you want to place, for example a Class, by clicking on the icon in the Toolbox and click on the diagram. This will place a new Class item instance 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.

Some elements are not directly visible. The section in the toolbox is collapsed and needs to be clicked first to reveal its contents.

Gaphor only has one diagram type, and it does not enforce which elements should be placed on a diagram.

Create a New Diagram

  1. Use the Navigation to select an element that can contain a diagram (a Package or Profile)
  2. Select Diagram, and New diagram. A new diagram is created.

Copy and Paste

Items in a diagram can be copied and pasted in the same diagram or other diagrams. Pasting 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.

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 Boduch

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

Alexander Wilms

๐Ÿ›

Alexis Howells

๐Ÿ“–

Arjan Molenaar

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

Blippost

๐Ÿค”

Brock Tibert

๐Ÿ›

Christian Hoff

๐Ÿ’ป

Dan Yeaw

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

Daniel Nylander

๐ŸŒ

DimShadoWWW

๐Ÿ›

Encolpe DEGOUTE

๐ŸŒ

Enno Grรถper

๐Ÿ’ป

Enno Zickler

๐Ÿ›

Fran Diรฉguez

๐ŸŒ

Gleb Smirnov

๐Ÿ›

Gytree

๐Ÿ›

Ikko Ashimine

๐Ÿ’ป

Jan

๐Ÿ›

JensPfeifle

๐Ÿ“–

Jonathan

๐Ÿค” ๐Ÿ›

JonnathanRiquelmo

๐ŸŒ

Jordi Mallach

๐ŸŒ

Jorge DLG

๐Ÿ›

Kapil Thangavelu

๐Ÿ›

Lordy

๐Ÿ›

Mark Kennedy

๐Ÿค” ๐Ÿ’ป ๐Ÿ›

Matthew Maclaine

๐Ÿ›

Mek101

๐Ÿ›

Michael Patrick Tkacik

๐Ÿ›

Mikhail Bessonov

๐Ÿ›

Nedko Arnaudov

๐Ÿ›

Rafael Muรฑoz Cรกrdenas

๐Ÿ›

Rui Maciel

๐Ÿค”

Seong-ho Cho

๐ŸŒ

Steve Kossouho

๐Ÿ› ๐Ÿ’ป

Steven Liu

๐Ÿ›

Tiemen Schuijbroek

๐Ÿ› ๐Ÿ’ป

Tobias Bernard

๐ŸŽจ ๐Ÿค”

TomBous

๐Ÿ›

Tomasz Droลผdลผ

๐Ÿค”

Tony

๐Ÿšง

Xander982

๐Ÿ–‹ ๐Ÿ›

Yauhen Kirylau

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

Zsolt Sandor

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

albanobattistella

๐ŸŒ

freddii

๐Ÿค” ๐Ÿ“–

freezed-or-frozen

๐Ÿ›

fu7mu4

๐ŸŒ

gavr123456789

๐Ÿค”

kellenmoura

๐Ÿ›

melisdogan

๐Ÿ“–

milotype

๐ŸŒ ๐Ÿ“–

mskorkowski

๐Ÿ›

ovari

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

samirodj

๐Ÿ›

seryafarma

๐Ÿ“–

sib@c

๐Ÿ› ๐Ÿค”

tronta

๐Ÿ›

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 master 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.

Project details


Download files

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

Files for gaphor, version 2.7.1
Filename, size File type Python version Upload date Hashes
Filename, size gaphor-2.7.1.tar.gz (407.0 kB) File type Source Python version None Upload date Hashes View
Filename, size gaphor-2.7.1-py3-none-any.whl (621.3 kB) File type Wheel Python version py3 Upload date Hashes View

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