Microsoft TFS Python Library (TFS API Python client)¶
Introduction¶
Microsoft Team Foundation Server Python Library is a Microsoft TFS API Python client that can work with Microsoft TFS workflow and workitems.
Quick Start¶
This python library allows:
- Get work Items (WI)
- Set WI fields
- Run WI search queries
- Run WIQL
- Work with TFVC changesets
- Work with TFS Projects
- Advanced usage - what is
tfs.TFSObject
, - find and add with Workitem relations,
links, and information about
tfs.TFSHTTPClient
- Advanced usage - what is
- Some other objects available -
tfs.Changesets
,tfs.Project
, Team
Troubleshooting¶
If you cannot create or update a work item, here are some possible reasons:
- check if the account you use has enough permissions in the collection/project
- make sure you follow your workflow, work items might have required fields or any other sort of restrictions
- verify that the api version fits your team foundation server version
If neither of these helped your case - look through our issues list.
If there is no similar issue - create one.
Guide¶
If you use this library, put a star on this repository. This motivates us and other developers to develop the library :)
Compatibility¶
- Tested with Python.3.4
- TFS 2015
- TFS 2017