pylover / adia Goto Github PK
View Code? Open in Web Editor NEWASCII diagram language & generator for UML sequence diagram.
License: MIT License
adia's People
Contributors
Stargazers
Watchers
adia's Issues
Javascript page is outdated.
Language specification.
Sequence diagram break not working
diagram: Authentication
version: 1.0
author: pylover
sequence: Foo
foo -> bar
sequence: Bar
bar -> baz
DIAGRAM: Authentication
author: pylover
version: 1.0
SEQUENCE: Bar
+-----+ +-----+ +-----+
| foo | | bar | | baz |
+-----+ +-----+ +-----+
| | |
|~~~~~~>| |
| | |
|<------| |
| | |
| |~~~~~~>|
| | |
| |<------|
| | |
+-----+ +-----+ +-----+
| foo | | bar | | baz |
+-----+ +-----+ +-----+
Quickstart
Tutorials
Remove brython.js from version control
Use `=>` to determine the return value.
foo -> bar: hello => hi
Javascript API: Use web workers to run in the background.
Create setup.py
Vim syntax highlihgting
Condition inside self-call
diagram: Authentication
version: 1.0
author: pylover
sequence: Login
alice -> bob: authenticate(email, password) -> token
bob -> bob: db.ensure()
if: not db.is_connected
bob -> db: connect()
DIAGRAM: Authentication
author: pylover
version: 1.0
SEQUENCE: Login
+-------+ +-----+ +-----+
| alice | | bob | | db |
+-------+ +-----+ +-----+
| | |
|~~~authenticate(email, password)~~~~>| |
| |~~~db.ensure()~~~+ |
| | |
| ****************************
| * if not db.is_connected *
| ****************************
| | |
| |~~~connect()~~~~~~~>|
| | |
| |<-------------------|
| | |
| ****************************
| * end if *
| ****************************
| | | |
| |<----------------+ |
|<--token-----------------------------| |
| | |
+-------+ +-----+ +-----+
| alice | | bob | | db |
+-------+ +-----+ +-----+
VIM plugin to auto-render commented blocks
CI/CD
Make diagram keyword optional
CONTRIBUTING.md
- make env
- make doc
- make livedoc
- make lint
- make cover
- make test
- make serve
- make clean
- make cleanall
- Client side tests
Link to adia live demo from documentation and gh readme
Profile
Paralell call
Unexpected syntax error
diagram: Foo
<space><space>
# First section
Error
Syntax Error: BadSyntax: File "String", Interpreter: Diagram, line 3, col 0
Expected one of `# INDENT NEWLINE EOF NAME`, got: `DEDENT`.
Github flavoured markdown syntax highlighting
Blank line at second or greater indentation level has unexpected behavior
diagram: Foo
sequence: Hello
foo -> bar
bar -> baz
baz -> qux
Output
DIAGRAM: Foo
SEQUENCE: Hello
+-----+ +-----+ +-----+ +-----+
| foo | | bar | | baz | | qux |
+-----+ +-----+ +-----+ +-----+
| | | |
|~~~~~~>| | |
| |~~~~~~>| |
| | | |
| |<------| |
| | | |
| | |~~~~~~>|
| | | |
| | |<------|
|<------| | |
| | | |
+-----+ +-----+ +-----+ +-----+
| foo | | bar | | baz | | qux |
+-----+ +-----+ +-----+ +-----+
Sphinx
Provide ADia version inside the javascript API as an attribute.
aDia.__version__Sphinx extension
Docs: https://www.sphinx-doc.org/en/master/usage/extensions/index.html
Similar implementation: https://github.com/mgaitan/sphinxcontrib-mermaid
Implement tokenizer
Initial tokenizer based on CPython implementation.
ASCII Tables
| Days off | Reason | Dates off | Days remaining |
|----------+----------------------+------------+----------------|
| 1 | Door installed | 10 January | 27 |
| 0.5 | Garage tidy | 28 January | 26.5 |
| 1 | Bank, garage, Hagino | 8 February | 25.5 |
Include directive
Publish documents using CI/CD
And issue doctest before each release.
Fork diagram
- Example of Git branching
- Example of Unix fork
test pcap main httpd
. . . .
. . . .
START . . .
| . . .
|________________ . .
| . .
fork . .
________________|\___________ .
| | .
test | .
| | .
stop fork .
|________________ |\______________
| | |
kill ------> kill ---------> loop
| | ______________|
wait |/
| join
| ___________|
|/
join
________________|
|
EXIT
Sequence diagram interpreter.
Rename the project to `adia`
adia stands for ASCII Diagram.
Command line interface
About the ADia
setup.py
PyPI and python package
Branding
- Logo
Self-call inside condition
diagram: Authentication
version: 1.0
author: pylover
sequence: Login
bob -> db: ensure()
if: not db.is_connected
db -> db: connect()
DIAGRAM: Authentication
author: pylover
version: 1.0
SEQUENCE: Login
+-----+ +-----+
| bob | | db |
+-----+ +-----+
| |
|~~~ensure()~~~~~~~~~~~~~~~~~~~~~~>|
| |
| *******
| * if not db.is_connected
| *******
| |
| |~~~connect()~~~+
| | |
| |<--------------+
| |
| *******
| * end if
| *******
| |
|<---------------------------------|
| |
+-----+ +-----+
| bob | | db |
+-----+ +-----+
Google analytics
Class diagram
+---------------+ +------------------+
| struct peer | +------>| enum peer_state |
+---------------+ | +------------------+
| +fd | | | PS_READ |
| state >---+ | PS_WRITE |
| writebuff[] | +------------------+
| writerb |
| *handler | +------------------+
+---------------+ +-->| struct ev_epoll |
| +------------------+
+-----------------+ +---------------+ | | epollfd |
| struct ev | +-->| union ev_priv | | +------------------+
+-----------------+ | +---------------+ |
| id | | | ev_epoll >-------+ +------------------+
| forks | | | ev_select >---------->| struct ev_select |
| children[] | | | ev_mock >-------+ +------------------+
| private_data >--+ +---------------+ | | ? |
+-----------------+ | +----------------- +
| *on_recvd | |
| *on_writefinish | | +------------------+
+-----------------+ +-->| struct ev_mock |
^ ^ +------------------+
| | | ? |
| +--------------+ +------------------+
| |
+---^-----------+ +---^------------+
| struct ev_srv | | struct ev_clnt |
+---------------+ +----------------+
| +struct ev | | +struct ev |
| listenfd | | hostname |
| bind | | port |
+---------------+ +----------------+
| *on_connect | | ? |
+---------------+ +----------------+
Javascript release
How to use inside javascript
Escape character
Feature list
Documentation and GH readme.
Popular badges
- PyPI
- Build
- Coveralls
- CPython
- Brython
- Github Forks
Theme
Extra right padding due @note
diagram: Authentication
version: 1.0
author: pylover
sequence: Login
alice.title: Alice
bob.title: Bob
db.title: Database
@alice ~ bob: Alice tries to authenticate herself
alice -> bob: authenticate(email, password) -> token
if: not db.is_connected
bob -> db: connect()
for: each oldtoken in db
bob -> db: delete(oldtoken)
@alice: |
Alice decides to
store the newly
received Token
in a safe place.
alice -> alice: store(token)
DIAGRAM: Authentication
author: pylover
version: 1.0
SEQUENCE: Login
+-------+ +-----+ +-----------+
| Alice | | Bob | | Database |
+-------+ +-----+ +-----------+
| | |
--------------------------------------------------- |
| Alice tries to authenticate herself | |
--------------------------------------------------- |
| | |
|~~~authenticate(email, password)~~~~~~~~~>| |
| | |
| ***********************************
| * if not db.is_connected *
| ***********************************
| | |
| |~~~connect()~~~~~~~~~~~>|
| | |
| |<-----------------------|
| | |
| ***********************************
| * end if *
| ***********************************
| | |
| ***********************************
| * for each oldtoken in db *
| ***********************************
| | |
| |~~~delete(oldtoken)~~~~>|
| | |
| |<-----------------------|
| | |
| ***********************************
| * end for *
| ***********************************
| | |
|<--token----------------------------------| |
| | |
--------------------- | |
| Alice decides to | | |
| store the newly | | |
| received Token | | |
| in a safe place. | | |
--------------------- | |
| | |
|~~~store(token)~~~+ | |
| | | |
|<-----------------+ | |
| | |
+-------+ +-----+ +-----------+
| Alice | | Bob | | Database |
+-------+ +-----+ +-----------+
Sphinx syntax highlighting.
Full PEP8, PEP287 and flake8 coding style check
API documentation
While loop rendering problem
diagram: ADia Web Wroker
author: Vahid Mardani
sequence:
a.title: adia.js
w.title: adia_worker.py
while: worker is not initialized
a -> a: Wait()
DIAGRAM: ADia Web Wroker
author: Vahid Mardani
+---------+ +-----------------+
| adia.js | | adia_worker.py |
+---------+ +-----------------+
| |
******************************** |
* while worker is not initialized |
******************************** |
| |
|~~~Wait()~~~+ |
| | |
|<-----------+ |
| |
******************************** |
* end while * |
******************************** |
| |
+---------+ +-----------------+
| adia.js | | adia_worker.py |
+---------+ +-----------------+
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.