From 4807c872a4fc7804ac5b839354b49a2f5f441b32 Mon Sep 17 00:00:00 2001 From: Marc Abramowitz Date: Wed, 3 Aug 2016 23:41:13 -0700 Subject: [PATCH] Add note to README.md about new API pointing to https://github.com/SurveyMonkey/pyteamcity/pull/37 --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 85a6fbd..f58364f 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,25 @@ API](https://confluence.jetbrains.com/display/TCD9/REST+API) of pip install pyteamcity ``` +## New API work-in-progress + +Note that I am working on a new API -- see +https://github.com/SurveyMonkey/pyteamcity/pull/37 + +Goal here is to create a brand new API that is much more flexible and to +have nicer code that is easier to work with. The old code encourages +adding a zillion methods for different ways of filtering. The new code +has an API with a smaller number of methods that are more consistent and +more flexible in terms of filtering. It is modeled after the Django ORM +API. + +This is a work-in-progress. Notably missing are `UserGroup` and +`QueuedBuild` models. + +I am probably not going to merge PRs that add things to the old API, +because I see the new API as the future. I of course am very interested +in PRs that add things to the new API! + ## Examples ### Connect to server