User

Just another Python API for Travis CI (API).

A module which provides the “User” resource type.

Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Project link:
https://github.com/funilrys/PyTravisCI
Project documentation:
https://pytravisci.readthedocs.io/en/latest/

License

MIT License

Copyright (c) 2019, 2020 Nissar Chababy

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.
class PyTravisCI.resource_types.user.User(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the information of a user.

Official Travis CI API documentation:
Variables:
  • id (int) – Value uniquely identifying the user.
  • login (str) – Login set on Github.
  • name (str) – Name set on GitHub.
  • github_id (int) – Id set on GitHub.
  • vcs_id – The user’s vcs_id.
  • vcs_type – The user’s vcs_type.
  • avatar_url (str) – Avatar URL set on GitHub.
  • education (bool) – Whether or not the user has an education account.
  • allow_migration – The user’s allow_migration.
  • email (str) – The user’s email.
  • is_syncing (bool) – Whether or not the user is currently being synced with Github.
  • synced_at (datetime) – The last time the user was synced with GitHub.
  • recently_signed_up – The user’s recently_signed_up.
  • secure_user_hash – The user’s secure_user_hash.
  • repositories (List[Repository]) – Repositories belonging to this user.
  • installation (Installation) – Installation belonging to the user.
  • emails – The user’s emails.
get_active(*, params: Optional[dict] = None) → PyTravisCI.resource_types.active.Active[source]

Provides the list of active builds of the current user.

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.
get_beta_features(*, params: Optional[dict] = None) → PyTravisCI.resource_types.beta_features.BetaFeatures[source]

Provides the list of beta features of the current user.

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.
synchronize(*, params: Optional[dict] = None) → bool[source]

Triggers a synchronization between Travis CI and the user Github account.

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.