No project description provided
Project description
docbooktoxtm
Utility for prepping DocBook XML packages for use as XTM source files.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
Install docbooktoxtm with pip
.
$ pip install docbooktoxtm
or
$ python3 -m pip install docbooktoxtm
The script also requires a GitHub API token be exported as an environment variable named github_token
. The script will automatically pick up the token if correctly configured and will route things properly. For information on creating a personal access token, visit GitHub's help article on the subject for more information.
Usage
$ docbooktoxtm [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Commands:
resource
: Restructures source file structure for more...unsource
: Restores target files exported from XTM to...
docbooktoxtm resource
Restructures source file structure for more efficient parsing in XTM.
Usage:
$ docbooktoxtm resource [OPTIONS] TARGET_FNAME
Options:
TARGET_FNAME
: name of target .zip package [required]--help
: Show this message and exit.
docbooktoxtm unsource
Restores target files exported from XTM to original source file structure.
Usage:
$ docbooktoxtm unsource [OPTIONS] COURSE
Options:
COURSE
: course name or name of source .zip package [required]-r, --release-tag TEXT
: optional GitHub release tag--help
: Show this message and exit.
Authors
- Ryan O'Rourke
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docbooktoxtm-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 962abe9b0e42a5743fda01f3d01222dfac093d64276b4a43a9f58b0f15e8d426 |
|
MD5 | 88480951f8d1014975d001d9463d473e |
|
BLAKE2b-256 | a0ef0f937f0c45de38939a109ac394df741efabc5ef2300e027d21c616851f7d |