Giter Site home page Giter Site logo

Comments (2)

Lecrapouille avatar Lecrapouille commented on May 29, 2024 1

Oh I missed your graph generation ! Nice for github projects while usually, in professional project a software architect draws first the state machine and a dev-guy codes it after ... not the inverse :)

from python-statemachine.

fgmacedo avatar fgmacedo commented on May 29, 2024

Hi @Lecrapouille , thanks for pointing out this. Nice job on the lib!

One of the great benefits of using this library and something that I'm proud of is having a clean and concise representation of a state machine that is understandable from reading the code.

So my approach to SM is the opposite, when I need to make a diagram, I write the code in a my_sm.py file and generate the graph using the command line, for example:

 python -m statemachine.contrib.diagram my_sm.py my_sm.png

See examples of how to get diagrams from source code automatically.

This code first approach evolves better since diagrams using those tools get aged on the day the first line of code is written. If you generate the diagram from code automatically, you can still communicate with diagrams in your docs but is sure that the diagram is kept up to date.

Since I'm not aligned to work on this and it's not a direct requirement for the library, I'll close the issue. Maybe if someone is able to make it happen, we can have an implementation directly on your library as an alternative output for the same parser.

Thanks again!

from python-statemachine.

Related Issues (20)

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.