No description, website, or topics provided.
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

#XMind SDK for python

XMind SDK for python to help Python developers to easily work with XMind files and build XMind extensions.

##Install XMind SDK for python

Clone the repository to a local working directory

git clone https://github.com/xmindltd/xmind-sdk-python.git

Now there will be a directory named xmind-sdk-python under the current directory. Change to the directory xmind-sdk-python and install XMind SDK for python.

python setup.py install

It is highly recommended to install XMind SDK for python under an isolated python environment using virtualenv

##Usage

Open an existing XMind file or create a new XMind file and place it into a given path

import xmind
workbook = xmind.load(/path/to/file/)  # Requires '.xmind' extension

Save XMind file to a path. If the path is not given then the API will save to the path set in the workbook

xmind.save(workbook)

or:

xmind.save(workbook, /save/file/to/path)

##LICENSE

The MIT License (MIT)

Copyright (c) 2013 XMind, Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.