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.2.tar.gz (9.3 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.2-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xcm_wiki_gen-0.1.2.tar.gz
  • Upload date:
  • Size: 9.3 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.2.tar.gz
Algorithm Hash digest
SHA256 939cab0fe5f55e56ae9a6cc6a25d320f75def64845821293b29b3c173a061636
MD5 eb65388528e7597c4f029f2a85025605
BLAKE2b-256 e4f489673d62f5ad416d03f6648fef79624d4c074286276d0cb19136d0355f65

See more details on using hashes here.

File details

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

File metadata

  • Download URL: xcm_wiki_gen-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d465b95d0d3f54bead1a6448dfae4fc2568d07ad6dfe26b6cf5aa036f84f1a11
MD5 4942f6ca24ff1ced36d73a6ff016787f
BLAKE2b-256 e788e076342302ff63d508592f6cac19857aeddf95f4e9a81aeadba10dce6724

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