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
1 maintainer
Release files for docbooktoxtm 1.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| docbooktoxtm-1.2.1.tar.gz | 10.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| docbooktoxtm-1.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.6 kB
Release files / docbooktoxtm-1.2.1.tar.gz
| Download URL | docbooktoxtm-1.2.1.tar.gz |
|---|---|
| Size | 10.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d5b3a8954eb1ced59e1dd46fc276cf4ca57be947a85b949c4dcec8265c3f388
|
|
BLAKE2b-256 checksum How to use checksums |
82b981f5eb5fd8eabc0257096606d604f5b32bf86150a069af568f4338cd4cc6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.10 CPython/3.8.5 Linux/5.7.15-200.fc32.x86_64
|
Release files / docbooktoxtm-1.2.1-py3-none-any.whl
| Download URL | docbooktoxtm-1.2.1-py3-none-any.whl |
|---|---|
| Size | 11.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
962abe9b0e42a5743fda01f3d01222dfac093d64276b4a43a9f58b0f15e8d426
|
|
BLAKE2b-256 checksum How to use checksums |
a0ef0f937f0c45de38939a109ac394df741efabc5ef2300e027d21c616851f7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.0.10 CPython/3.8.5 Linux/5.7.15-200.fc32.x86_64
|
