Gaphor is the simple modeling tool written in Python.
Project description
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
๐ 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 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):
This project follows the all-contributors specification. Contributions of any kind are welcome!
- 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.
- Fork the repository on GitHub to start making your changes to the main branch (or branch off of it).
- Write a test which shows that the bug was fixed or that the feature works as expected.
- Send a pull request and bug the maintainers until it gets merged and published. :smile:
๐ 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 ยฉ 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
