Skip to main content

Generates a set of GitHub Wiki class and relationship description template markdown files from an input xcm (executable class model) file.

Project description

Class Model Description Wiki Template Generator

Here we take an *.xcm file (Executable Class Model) as input and output a set of class and relationship description markdown files into a local Github wiki directory.

This saves a lot of typing and cut and paste creating the wiki documentation of an Executable UML class model.

Let's say you have a file named elevator.xcm in the current working directory

Just do this:

% wikigen -m elevator.xcm -w ev_wiki

-m specifies the path to your xcm file

-w specifies the target wiki directory, it will be created if it does not exist

Any files in the target directory will be overwritten each time you run the command.

There are some debug options, version etc.

Type:

% wikigen -help

To get the most up to date list of options

Project details


Download files

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

Source Distribution

xcm_wiki_gen-0.1.0.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xcm_wiki_gen-0.1.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file xcm_wiki_gen-0.1.0.tar.gz.

File metadata

  • Download URL: xcm_wiki_gen-0.1.0.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for xcm_wiki_gen-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d7929f6094041844253515248532f6461dda29bef559b424faf3a349d9263caf
MD5 2ba86b219b5ed883a8f893c39e90cf38
BLAKE2b-256 2877f0a4875ad456557ee05c53553edf0f0694934b804494007a513e2d734059

See more details on using hashes here.

File details

Details for the file xcm_wiki_gen-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: xcm_wiki_gen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for xcm_wiki_gen-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2a91d5c3171b392b440c26f2d72faa8062eddac63e25b2a1caf4c4351ef7667
MD5 099638a2d8262020bfac7587e9d87675
BLAKE2b-256 ef9d4f6d92b16bb53848e37a14a524e47837219c9ae0cef556a37e525f351661

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page