Welcome to the XN-Twist Python SDK documentation!¶
Contents:
XN-Twist Python SDK¶
Python SDK for talking with XN-Twist’s API . Note: this package is not designed to be your primary interaction with the XN-Twist API. This is simply a package to aid the management of the API and is used behind the scenes in the xn-twist package.
Installation¶
Stable release¶
To install the XN-Twist Python SDK, run this command in your terminal:
$ pip install xn_twist_python_sdk
This is the preferred method to install the XN-Twist Python SDK, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for the XN-Twist Python SDK can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/xn-twist/xn-twist-python-sdk
Or download the tarball:
$ curl -OL https://github.com/xn-twist/xn-twist-python-sdk/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
Usage¶
from xn_twist_python_sdk import xn_twist_python
# instantiate an instance of the XN-Twist Python SDK
xn_sdk = xn_twist_python.XnTwistSDK()
Credits¶
This package was created with Cookiecutter and the `fhightower/python-project-template`_ project template.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/xn-twist/xn-twist-python-sdk/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation¶
XN-Twist Python SDK could always use more documentation, whether as part of the official XN-Twist Python SDK docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/xn-twist/xn-twist-python-sdk/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up xn-twist-python-sdk for local development.
Fork the xn-twist-python-sdk repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:<your_github_username_here>/xn-twist-python-sdk.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv xn-twist-python-sdk $ cd xn-twist-python-sdk/ $ python setup.py developCreate a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 xn-twist-python-sdk tests $ python setup.py test or py.test $ toxTo get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-featureSubmit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/xn-twist/xn-twist-python-sdk/pull_requests and make sure that the tests pass for all supported Python versions.