Skip to content

Commit

Permalink
Add note to README.md about new API
Browse files Browse the repository at this point in the history
pointing to #37
  • Loading branch information
msabramo committed Aug 4, 2016
1 parent a673d90 commit 4807c87
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4807c87

Please sign in to comment.