Giter VIP home page Giter VIP logo

gaphor.github.io's Introduction

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

๐Ÿ›
Antonio Mejia
Antonio Mejia

๐ŸŒ
Arjan Molenaar
Arjan Molenaar

๐Ÿ’ป ๐Ÿ› ๐Ÿ“– ๐Ÿ‘€ ๐Ÿ’ฌ ๐Ÿ› ๐Ÿ”Œ โš ๏ธ
Aurรฉlien Joga
Aurรฉlien Joga

๐Ÿ“–
Bill ZHANG
Bill ZHANG

๐ŸŒ
Bjรถrn Strรถmberg
Bjรถrn Strรถmberg

๐Ÿ›
Blippost
Blippost

๐Ÿค”
Brage Fuglseth
Brage Fuglseth

๐ŸŽจ
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

๐ŸŒ
Francisco Gouveia
Francisco Gouveia

๐Ÿ’ป
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

๐Ÿ’ป
JACKADUX
JACKADUX

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

๐Ÿ›
Joรฃo Correia
Joรฃo Correia

๐Ÿ’ป
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

๐Ÿ›
Nathan Hadley
Nathan Hadley

๐ŸŒ
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

๐Ÿ›
Teun Hoevenaars
Teun Hoevenaars

๐Ÿ“–
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

๐Ÿ’ป โš ๏ธ ๐Ÿ› ๐ŸŽจ
zhangxinqiang
zhangxinqiang

๐ŸŒ
ร“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. ๐Ÿ˜„

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.

gaphor.github.io's People

Contributors

adhadse avatar albanobattistella avatar amolenaar avatar anzhumal avatar braiso-22 avatar bugurtit avatar danyeaw avatar dependabot[bot] avatar dodoledev avatar efishell0 avatar finnurthorisson avatar flipflop97 avatar foo-dogsquared avatar github-actions[bot] avatar jposada202020 avatar kbdharun avatar mikekidner avatar milotype avatar necrokote avatar oscfdezdz avatar ovari avatar petalzu avatar ponfertato avatar rffontenelle avatar ser82-png avatar vikdevelop avatar weblate avatar wistorgred avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gaphor.github.io's Issues

Russian language support in fonts

The site is currently using the Lato 1.0 font, which does not support the Russian language.

There are two solutions to this problem:

  1. Use Lato 2.0 font;
  2. Use a different font.

It seems that the first solution is much simpler and better.

Information about Lato: https://www.latofonts.com

And I also noticed that the font used for the title - Poppins - also does not support the Russian language. There is a font similar to it - Montserrat - it does.

Update Jekyll and Dependencies

We are running older version of most of our dependencies. This was set up since we were using auto deployment with GitHub Actions, but now we have our own build and can run the latest and greatest:

  • Ruby 2.7.5, latest is 3.2.2
  • Jekyll 3.9.3, latest is 4.3.2
  • Bootstrap 4.5.0, latest 5.2.3

We also depend on the github-actions gem which pulls in 40+ dependencies, it would be great to specify only exactly what we need.

Add German to the language dropdown list

The Gaphor app is translated into German.
The website isn't translated completely yet.
Nevertheless, please enable switching to German translation in the language dropdown menu by adding "de": "Deutsch" to the _data/languagenames.json file.

Gallary with examples

If you look at d3.js and click on Examples or if you look at Graphviz they have a gallery that showcases what can be done.

Maybe Gaphor could also have a examples or gallery section that showcases some models with screenshots and that can also be downloaded.

Please allow at https://gaphor.org/hu/ the following to be translatable

Please allow at https://gaphor.org/hu/ the following to be translatable:

  1. Build Class, Interaction, and State Machine diagrams for software or Block Definition and Requirements diagrams for systems. Model the elements you need. If you want to mix and match, you can even add different diagram items to the same diagram to get the view you need.
  2. Customize the diagrams you create with our built-in styling engine.
  3. Easily find all element of your model in the tree view.
  4. Love dark mode? We can do that too.
  5. There are many ways to install Gaphor. The simplest is to download the official installer for Windows or macOS. For Linux you can install Gaphor using FlatHub. You can also use Pythonโ€™s built-in pip tool as long as you have all the required dependencies installed.
  6. Blog and News
  7. [Contact the team](https://gaphor.org/hu/discuss) if you want to share content related to Gaphor.
  8. We love to hear from you
  9. [Open an issue on GitHub](https://github.com/gaphor/gaphor/issues)
  10. [Tech docs](https://docs.gaphor.org/en/latest)
  11. Theme:

Thank you

Append `en-US/` to the English edition of the website

Instead of showing https://gaphor.org/ when visiting the English version of the Gaphor website, suggest changing this to https://gaphor.org/en-US/

In future, if https://gaphor.org/ is entered as the URL, that page would determine the locale on the visitors device and then automatically redirect to that locale. If that locale is currently not available on Gaphor, then the visitor would be redirected to https://gaphor.org/en-US/.

This is how https://www.thunderbird.net/ works. Please try it as see how to redirects to the current locale of your device.

The Thunderbird website code is available at https://github.com/thundernest/thunderbird-website if you would like to have a look.

What do you think?

Thank you

Switching language returns to home page

Currently the website does not completely translate into defined languages. Some context translates, some of it doesn't.

Also, when changing the language of a certain web-page, switching languages always returns to the main web page (home-page) of the selected language. It should simply display the same page but in the other language.

For instance:

Same is true for Hungarian ...

Darker color for body text

I know this is based on a theme but the body text is really hard to see unless it is zoomed in my display. The current body text color of #8C9597 with a background of #ffffff does not pass to a WCAG contrast checker (at least on a normal body text).

Screenshot from 2023-01-31 23-11-22

I suggest a darker color for the body text to make it more visible. Here's #565e60 alongside the updated screenshot of the website. It also passes most of the checks as well.

Screenshot from 2023-02-01 09-48-31

Enable translation of navigation

Please enable top row strings to be translatable.

  1. About top row string
  2. Download top row string
  3. Blog top row string
  4. GitHub repository top row popout string
  5. Perhaps all the string in the top row need translation to be enable as the strings that look like they are in Weblate are duplicated

image

Thank you

Automatically Select Locale for Users

Feature Request

Make the website automatically recognize the user's language/locale settings (browser or OS settings) and show the website in that language.

Please also consider my suggestion in issue #61. This enables the user to automatically read the website's contents in his/her langauage, but still be able to switch to another language if needed.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.