Resource Types

Resource types are objects provides by the Travis CI API documentation. For us, as developers they are our direct way to interact with their API.

Please keep in mind, that I built this tool to stay as close as possible from the official documentation located at https://developer.travis-ci.org. Most of the resource types are documented correctly but Travis CI will continue its development cycle, there please take a look at their documentation from time to time.

One of the rare things which was leaved undocumented are the params. Therefore, using this tool without the documentation while using the params argument may be a lost of time.

Warning

I tried to make the attributes match the documentation. But with the time some may be missing. You are invited to report them per issue or pull request.

Not implemented

Here is the list of resource types which are not (yet) implemented into this project. Feel free to submit your PR!

Base

Just another Travis CI (API) Python interface.

A module which provides the base of all our resource type objects.

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.base.ComplexJsonEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]

Provides ours complex JSON encoder.

default(o: Any)[source]

Implements our complex conversion to JSON.

class PyTravisCI.resource_types.base.ResourceTypesBase(**kwargs)[source]

The base of all ressource types.

dict(*, remove_tags: bool = False) → str[source]

Alias of to_dict.

first_page() → Optional[ResourceTypesBase][source]

Provides the first page.

Raises:FirstPageNotFound – If the first page was not found.
get_complete() → Optional[ResourceTypesBase][source]

Provides the complete representation if the current representation is the minimal one.

has_first_page() → bool[source]

Checks if there is a first page to follow.

has_last_page() → bool[source]

Checks if there is a last page to follow.

has_next_page() → bool[source]

Checks if there is a next page to follow.

has_previous_page() → bool[source]

Checks if there is a previous page to follow.

is_incomplete() → bool[source]

Checks if the current object is incomplete.

An object is consired as incomplete if its representation is minimal.

json(*, remove_tags: bool = False) → str[source]

Alias of to_json.

last_page() → Optional[ResourceTypesBase][source]

Provides the last page.

Raises:LastPageNotFound – If the last page was not found.
next_page() → Optional[ResourceTypesBase][source]

Provides the next page.

Raises:NextPageNotFound – If the next page was not found.
previous_page() → Optional[ResourceTypesBase][source]

Provides the previous page.

Raises:PreviousPageNotFound – If the previous page was not found.
to_dict(*, remove_tags: bool = False) → PyTravisCI.resource_types.base.ResourceTypesBase.dict[source]

Converts the current object to dict.

Parameters:remove_tags – Remove all @tags and everything related to PyTravisCI.
to_json(*, remove_tags: bool = False) → str[source]

Converts the current object to json.

Parameters:remove_tags – Remove all @tags and everything related to PyTravisCI.

Active

Just another Travis CI (API) Python interface.

A module which provides the “Active” 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.active.Active(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of all “active” builds.

Official Travis CI API documentation:
Variables:builds (List[Build]) – The active builds.

Beta feature

Just another Travis CI (API) Python interface.

A module which provides the “Beta Feature” 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.beta_feature.BetaFeature(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a beta feature.

Official Travis CI API documentation:
Variables:
  • id (int) – Value uniquely identifying the beta feature.
  • name (str) – The name of the feature.
  • description (str) – Longer description of the feature.
  • enabled (bool) – Indicates if the user has this feature turned on.
  • feedback_url (str) – Url for users to leave Travis CI feedback on this feature.
delete() → Union[bool, PyTravisCI.resource_types.beta_feature.BetaFeature][source]

Deletes the current beta feature.

Parameters:params – The query parameters to append to the URL.
disable() → bool[source]

Disables the current beta feature.

enable() → bool[source]

Enables the current beta feature.

Beta features

Just another Travis CI (API) Python interface.

A module which provides the “Beta Features” 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.beta_features.BetaFeatures(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of all beta features

Official Travis CI API documentation:
Variables:beta_features (List[BetaFeature]) – The active builds.

Branch

Just another Travis CI (API) Python interface.

A module which provides the “Branch” 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.branch.Branch(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a branch.

Official Travis CI API documentation:
Variables:
  • name (str) – Name of the git branch.
  • repository (Repository) – GitHub user or organization the branch belongs to.
  • default_branch (bool) – Whether or not this is the respository’s default branch.
  • exists_on_github (bool) – Whether or not the branch still exists on GitHub.
  • last_build (Build) – Last build on the branch.
  • recent_builds (List[Build]) – Last 10 builds on the branch (when include=branch.recent_builds is used).
create_cron(interval: str, *, dont_run_if_recent_build_exists: bool = False, params: Optional[dict] = None) → PyTravisCI.resource_types.cron.Cron[source]

Creates a new cron associated to the current branch.

Official Travis CI API documentation:
Parameters:
  • interval – Interval at which the cron will run (can be daily, weekly or monthly).
  • dont_run_if_recent_build_exists – Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  • params – The query parameters to append to the URL.
get_cron(*, params: Optional[dict] = None) → Optional[PyTravisCI.resource_types.cron.Cron][source]

Provides the cron of the current branch.

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

Branches

Just another Travis CI (API) Python interface.

A module which provides the “Branches” 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.branches.Branches(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provide the list of branches of a chosen repository.

Official Travis CI API documentation
Variables:branches (List[Branch]) – List of branches.

Broadcast

Just another Travis CI (API) Python interface.

A module which provides the “Broadcast” 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.broadcast.Broadcast(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a broadcast.

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the broadcast.
  • message (str) – Message to display to the user.
  • created_at (:py:class`~datetime.datetime`) – When the broadcast was created.
  • category (str) – Broadcast category (used for icon and color).
  • active (bool) – Whether or not the brodacast should still be displayed.
  • recipient – Either a user, organization or repository, or null for global.

Broadcasts

Just another Travis CI (API) Python interface.

A module which provides the “Broadcasts” 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.broadcasts.Broadcasts(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of broadcasts.

Official Travis CI API documentation
Variables:broadcasts (List[Broadcast]) – List of broadcasts.

Build

Just another Travis CI (API) Python interface.

A module which provides the “Build” 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.build.Build(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a build

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the build.
  • number (str) – Incremental number for a repository’s builds.
  • state (str) – Current state of the build.
  • duration (int) – Wall clock time in seconds.
  • event_type (str) – Event that triggered the build.
  • previous_state (str) – State of the previous build (useful to see if state changed).
  • pull_request_title (str) – Title of the build’s pull request.
  • pull_request_number (int) – Number of the build’s pull request.
  • started_at (datetime) – When the build started.
  • finished_at (datetime) – When the build finished.
  • private (bool) – Whether or not the build is private.
  • repository (Repository) – GitHub user or organization the build belongs to.
  • branch (Branch) – The branch the build is associated with.
  • tag (str) – The build’s tag.
  • commit (Commit) – The commit the build is associated with.
  • jobs (List[Job]) – List of jobs that are part of the build’s matrix.
  • stages (List[Stage]) – The stages of the build.
  • created_by – The User or Organization that created the build.
  • updated_at (datetime) – The last time the build was updated.
cancel() → PyTravisCI.resource_types.build.Build[source]

Cancels the current build.

Raises:BuildAlreadyStopped – When the current build was already canceled.
get_jobs(*, params: Optional[dict] = None) → PyTravisCI.resource_types.jobs.Jobs[source]

Provides the list of jobs of the current build

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

Provides the list of stages of the current build

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.
is_active(*, sync: bool = False) → bool[source]

Checks if the build is active.

Parameters:sync – Authorizes the synchronization before checking.
is_canceled(*, sync: bool = False) → bool[source]

Checks if the build canceled.

Parameters:sync – Authorizes the synchronization before checking.
is_created(*, sync: bool = False) → bool[source]

Checks if the build is created.

Parameters:sync – Authorizes the synchronization before checking.
is_errored(*, sync: bool = False) → bool[source]

Checks if the build errored.

Parameters:sync – Authorizes the synchronization before checking.
is_failed(*, sync: bool = False) → bool[source]

Checks if the build failed.

Parameters:sync – Authorizes the synchronization before checking.
is_passed(*, sync: bool = False) → bool[source]

Checks if the build is passed.

Parameters:sync – Authorizes the synchronization before checking.
is_started(*, sync: bool = False) → bool[source]

Checks if the build is started.

Parameters:sync – Authorizes the synchronization before checking.
restart() → PyTravisCI.resource_types.build.Build[source]

Restarts the current build.

Raises:BuildAlreadyStarted – When the current build was already started.
sync() → PyTravisCI.resource_types.build.Build[source]

Fetches the latest information of the current job.

Builds

Just another Travis CI (API) Python interface.

A module which provides the “Builds” 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.builds.Builds(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the list of builds.

Official Travis CI API documentation
Variables:builds (List[Build]) – List of builds.

Cache

Just another Travis CI (API) Python interface.

A module which provides the “Cache” 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.cache.Cache(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a cache.

Warning

This resource type can’t be compared with any official resource type. In fact, at the time we write this, there no such thing officially in the Travis CI API documentation.

That’s the reason we don’t document much more.

delete() → bool[source]

Deletes the current cache.

Caches

Just another Travis CI (API) Python interface.

A module which provides the “Caches” 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.caches.Caches(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provide the list of caches of a chosen repository.

Official Travis CI API documentation
Variables:
  • caches (List[Cache]) – List of caches.
  • repo (Repository) – An internal representation of the repository linked to the current caches.
  • name (str) – The name of the repository linked to the current caches.
delete() → Union[bool, PyTravisCI.resource_types.caches.Caches][source]

Deletes the current cache

Cron

Just another Travis CI (API) Python interface.

A module which provides the “Cron” 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.cron.Cron(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a cron.

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the build.
  • repository (Repository) – Github repository to which this cron belongs.
  • branch (Branch) – Git branch of repository to which this cron belongs.
  • interval (str) – Interval at which the cron will run (can be “daily”, “weekly” or “monthly”).
  • dont_run_if_recent_build_exists (bool) – Whether a cron build should run if there has been a build on this branch in the last 24 hours.
  • last_run (datetime) – When the cron ran last.
  • next_run (datetime) – When the cron is scheduled to run next.
  • created_at (datetime) – When the cron was created.
  • active (bool) – The cron’s active.
delete() → Union[bool, PyTravisCI.resource_types.cron.Cron][source]

Deletes the current cron.

Crons

Just another Travis CI (API) Python interface.

A module which provides the “Crons” 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.crons.Crons(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the list of crons.

Official Travis CI API documentation
Variables:crons (List[Cron]) – List of crons.

Env var

Just another Travis CI (API) Python interface.

A module which provides the “Env Var” 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.env_var.EnvVar(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of an environment variable.

Official Travis CI API documentation
Variables:id (str) – The environment variable id.
:ivar str name;
The environment variable name, e.g. FOO.
Variables:
  • value (str) – The environment variable’s value, e.g. bar.
  • public (bool) – Whether this environment variable should be publicly visible or not.
  • branch – The env_var’s branch.
delete() → Union[bool, PyTravisCI.resource_types.env_var.EnvVar][source]

Deletes the current environment variable.

Official Travis CI API documentation:
make_private() → PyTravisCI.resource_types.env_var.EnvVar[source]

Makes this environment variable public.

Official Travis CI API documentation:
make_public() → PyTravisCI.resource_types.env_var.EnvVar[source]

Makes this environment variable public.

Official Travis CI API documentation:
set_branch(branch_name: str) → PyTravisCI.resource_types.env_var.EnvVar[source]

Sets the name of the branch which is covered by the current environment variable.

Official Travis CI API documentation:
Parameters:branch_name – The name of the branch to apply.
set_name(name: str) → PyTravisCI.resource_types.env_var.EnvVar[source]

Sets the new name of the current environment variable.

Official Travis CI API documentation:
Parameters:name – The new name
Raises:TypeError – Whether name is not str.
set_value(value: str) → PyTravisCI.resource_types.env_var.EnvVar[source]

Sets the new value of the current environment variable.

Official Travis CI API documentation:
Parameters:value – The new value.
Raises:TypeError – Whether value is not str.

Env vars

Just another Travis CI (API) Python interface.

A module which provides the “Env Vars” 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.env_vars.EnvVars(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the list of environment variables.

Official Travis CI API documentation
Variables:env_vars (List[PyTravisCI.resource_types.env_var.EnvVar]) – List of env_vars.

Installation

Just another Travis CI (API) Python interface.

A module which provides the “Installation” 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.installation.Installation(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a GitHub App installation

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the user.
  • github_id (int) – The installation’s id on GitHub.
  • owner – GitHub user or organization the installation belongs to.

Job

Just another Travis CI (API) Python interface.

A module which provides the “Job” 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.job.Job(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a single build.

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the job.
  • allow_failure (bool) – The job’s allow_failure.
  • number (str) – Incremental number for a repository’s builds.
  • state (str) – Current state of the job.
  • started_at (datetime) – When the job started.
  • finished_at (datetime) – When the job finished.
  • build (Build) – The build the job is associated with.
  • queue (str) – Worker queue this job is/was scheduled on.
  • repository (Repository) – GitHub user or organization the job belongs to.
  • commit (Commit) – The commit the job is associated with.
  • owner – GitHub user or organization the job belongs to.
  • stage (List[:class`~PyTravisCI.resource_types.stage.Stage`]) – The stages of the job.
  • created_at (datetime) – When the job was created.
  • updated_at (datetime) – When the job was updated.
cancel() → PyTravisCI.resource_types.job.Job[source]

Cancels the current job.

debug() → PyTravisCI.resource_types.job.Job[source]

Restart the current job in debug mode.

Warning

This method may not work if you are not allowed to restart in debug mode.

get_log(*, params: Optional[dict] = None) → PyTravisCI.resource_types.log.Log[source]

Provides the logs of the current job.

Parameters:params – The query parameters to append to the URL.
is_active(*, sync: bool = False) → bool[source]

Checks if the jpb is active.

Parameters:sync – Authorizes the synchronization before checking.
is_canceled(*, sync: bool = False) → bool[source]

Checks if the job canceled.

Parameters:sync – Authorizes the synchronization before checking.
is_created(*, sync: bool = False) → bool[source]

Checks if the job is created.

Parameters:sync – Authorizes the synchronization before checking.
is_errored(*, sync: bool = False) → bool[source]

Checks if the job errored.

Parameters:sync – Authorizes the synchronization before checking.
is_failed(*, sync: bool = False) → bool[source]

Checks if the job failed.

Parameters:sync – Authorizes the synchronization before checking.
is_passed(*, sync: bool = False) → bool[source]

Checks if the job is passed.

Parameters:sync – Authorizes the synchronization before checking.
is_started(*, sync: bool = False) → bool[source]

Checks if the job is started.

Parameters:sync – Authorizes the synchronization before checking.
restart() → PyTravisCI.resource_types.job.Job[source]

Restarts the current job.

Raises:JobAlreadyStarted – When the current job was already started.
sync() → PyTravisCI.resource_types.job.Job[source]

Fetches the latest information of the current job.

Jobs

Just another Travis CI (API) Python interface.

A module which provides the “Jobs” 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.jobs.Jobs(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of builds.

Official Travis CI API documentation
Variables:jobs (List[Job]) – List of jobs.

Key pair (Generated)

Just another Travis CI (API) Python interface.

A module which provides the “Key Pair (Generated)” 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.key_pair_generated.KeyPairGenerated(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a RSA key pair (generated).

Official Travis CI API documentation
Variables:
  • description (str) – A text description.
  • public_key (str) – The public key.
  • fingerprint (str) – The fingerprint.
regenerate() → PyTravisCI.resource_types.key_pair_generated.KeyPairGenerated[source]

Generates a new RSA key pair and return its representation.

Official Travis CI API documentation:

Key pair

Just another Travis CI (API) Python interface.

A module which provides the “Key Pair” 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.key_pair.KeyPair(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a key pair.

Official Travis CI API documentation
Variables:
  • description (str) – A text description.
  • public_key (str) – The public key.
  • fingerprint (str) – The fingerprint.
delete() → Union[bool, PyTravisCI.resource_types.key_pair.KeyPair][source]

Deletes the current key pair.

Official Travis CI API documentation:
set_description(description: str) → PyTravisCI.resource_types.key_pair.KeyPair[source]

Sets the new description of the current key pair.

Official Travis CI API documentation:
Parameters:value – The new value (private key).
Raises:TypeError – Whether value is not :py:class`str`.
set_value(value: str) → PyTravisCI.resource_types.key_pair.KeyPair[source]

Sets the new value (private key) of the current key pair.

Official Travis CI API documentation:
Parameters:value – The new value (private key).
Raises:TypeError – Whether value is not :py:class`str` nor :py:class`bytes`.

Lint

Just another Travis CI (API) Python interface.

A module which provides the “Lint” 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.lint.Lint(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a linting.

Official Travis CI API documentation
Variables:warnings (list) – An array of hashes with keys and warnings.
class PyTravisCI.resource_types.lint.LintWarning(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a placeholder for the lintings warnings.

Log

Just another Travis CI (API) Python interface.

A module which provides the “Log” 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.log.Log(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a job log.

Official Travis CI API documentation
Variables:
  • id (int) – The log’s id.
  • content (str) – The content of the log.
  • log_parts (list) – The log parts that form the log.
delete() → Union[bool, PyTravisCI.resource_types.log.Log][source]

Deletes the current log

Official Travis CI API documentation:

Message

Just another Travis CI (API) Python interface.

A module which provides the “Message” 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.message.Message(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of an individual message.

Official Travis CI API documentation
Variables:
  • id (int) – The log’s id.
  • level (str) – The message’s level.
  • key (str) – The message’s key.
  • code (str) – The message’s code.
  • args (dict) – The message’s args.
  • src – The message’s src.
  • line – The message’s line.

Messages

Just another Travis CI (API) Python interface.

A module which provides the “Messages” 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.messages.Messages(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of messages.

Official Travis CI API documentation
Variables:messages (List[PyTravisCI.resource_types.Message]) – List of messages.

Organization

Just another Travis CI (API) Python interface.

A module which provides the “Organization” 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.organization.Organization(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provide the description of an organization.

Official Travis CI API documentation
Variables:
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.

Organizations

Just another Travis CI (API) Python interface.

A module which provides the “Organizations” 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.organizations.Organizations(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of organization.

Official Travis CI API documentation
Variables:organizations (List[PyTravisCI.resource_types.organization.Organization]) – A list of organization.

Repositories

Just another Travis CI (API) Python interface.

A module which provides the “Repositories” 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.repositories.Repositories(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of repository.

Official Travis CI API documentation
Variables:repositories (List[PyTravisCI.resource_types.repository.Repository]) – A list of repository.

Repository

Just another Travis CI (API) Python interface.

A module which provides the “Repository” 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.repository.Repository(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a repository.

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the repository.
  • name (str) – The repository’s name on GitHub.
  • slug (str) – Same as {repository.owner.name}/{repository.name}.
  • description (str) – The repository’s description from GitHub.
  • github_id (int) – The repository’s id on GitHub.
  • vcs_id – The repository’s vcs_id.
  • vcs_type – The repository’s vcs_type.
  • github_language (str) – The main programming language used according to GitHub.
  • active (bool) – Whether or not this repository is currently enabled on Travis CI.
  • private (bool) – Whether or not this repository is private.
  • owner – GitHub user or organization the repository belongs to.
  • owner_name – The repository’s owner_name.
  • vcs_name – The repository’s vcs_name.
  • default_branch (Branch) – The default branch on GitHub.
  • starred (bool) – Whether or not this repository is starred.
  • managed_by_installation (bool) – Whether or not this repository is managed by a GitHub App installation.
  • active_on_org (bool) – Whether or not this repository runs builds on travis-ci.org (may also be null).
  • migration_status – The repository’s migration_status.
  • history_migration_status – The repository’s history_migration_status.
  • shared – The repository’s shared.
  • config_validation – The repository’s config_validation.
  • allow_migration – The repository’s allow_migration.
activate(*, params: Optional[dict] = None) → PyTravisCI.resource_types.repository.Repository[source]

Activates the current repository, allowing its test to be run on Travis Ci.

Parameters:params – The query parameters to append to the URL.
create_env_var(name: str, value: str, *, is_public: bool = False, branch: Optional[str] = None, params: Optional[dict] = None) → PyTravisCI.resource_types.env_var.EnvVar[source]

Creates a new environment variable into the current repository.

Official Travis CI API documentation:
Parameters:
  • name – The environment variable name, e.g. FOO.
  • value – The environment variable’s value, e.g. bar.
  • is_public – Whether this environment variable should be publicly visible or not.
  • branch – The env_var’s branch.
Raises:

TypeError – When the types of name and value are not :py:class`str`.
create_key_pair(description: str, value: Union[str, bytes], *, params: Optional[dict] = None) → PyTravisCI.resource_types.key_pair.KeyPair[source]

Creates a new RSA key pair.

Parameters:
  • description – A text description.
  • value – The private key.
Raises:

TypeError – When the types of name and value are not :py:class`str` nor :py:class`bytes`.
create_request(message: str, branch: str, *, config: Optional[dict] = None, params: Optional[dict] = None) → PyTravisCI.resource_types.request.Request[source]

Creates a Request

Parameters:
  • message – Travis-ci status message attached to the request.
  • branch – Branch requested to be built.
  • config – Build configuration (as parsed from .travis.yml).
Raises:

TypeError – When the types of name and value are not :py:class`str` nor :py:class`bytes`.
deactivate(*, params: Optional[dict] = None) → PyTravisCI.resource_types.repository.Repository[source]

Activates the current repository, preventing any tests from runningIs on Travis CI.

Parameters:params – The query parameters to append to the URL.
encrypt_env_var(env_vars: dict, padding: Optional[str] = 'PKCS1v15') → dict[source]

Process the encryption of the given environment variables.

Parameters:
  • env_vars –

    The key-value representing the environment variables to encrypt.

    Warning

    Spaces in keys will be automatically converted to underscore!

  • padding –

    The padding to use.

    Supported by PyTravisCI:

    • PKCS1v15
    • OAEP

    Supported by Travis CI:

    • PKCS1v15

    Warning

    DO NOT CHANGE THIS UNLESS INVITED TO.

    As of today, Travis CI use the PKCS1v15 padding. But it may be possible that one day they will change it to OAEP.

    Please report to the following references/discussion:
Returns:

A list representing each encrypted values.

As example, if the following is given:

{
    "HELLO": "WORLD",
    "WORLD": "HELLO"
}

The response will be:

[
    {"secure": "encrypted version of HELLO=WORLD" },
    {"secure": "encrypted version of WORLD=HELLo" }
]

encrypt_file(input_file: Union[io.IOBase, str], output_file: Union[io.IOBase, str], *, branch: Optional[str] = None) → dict[source]

Encrypts the content of the given input_file into output_file.

Side Effects:
  • Generates a new IV key.
  • Generates a new encryption key.
  • Save the IV key into a (new) repository environment variable.
  • Save the encryption key into a (new) repository environment variable.
Parameters:
  • input_file –

    The (plain) file to read.

    If a str is given, this method will open and close the file for you.

    If a io.TextIOWrapper is given, this method expects it to be in rb mode.

  • output_file –

    The file to write.

    If a str is given, this method will open and close the file for you.

    If a io.TextIOWrapper is given, this method expects it to be in wb mode.

  • branch – The branch to save the IV and key for.
Returns:

A dict which represents the data which are supposed to help the end-user decrypt the encrypted data.

Given an input file hello and an output file hello.enc, this method will provides the following:

{
    "command": "openssl aes-256-cbc -K "
    "$ENCRYPTED_BB6A5397D5B2_KEY -iv $ENCRYPTED_BB6A5397D5B2_IV "
    "-in hello.enc -out hello -d",
    "iv": {
        "ENCRYPTED_BB6A5397D5B2_IV": "hexadecimal representation of the IV."
    },
    "key": {
        "ENCRYPTED_BB6A5397D5B2_KEY": "hexadecimal representation of the key."
    },
}

encrypt_secrets(secrets: List[Union[str, bytes]], padding: Optional[str] = 'PKCS1v15') → str[source]

Encrypts the given secret.

Parameters:
Returns:

A list of encrypted secrets.
generate_key_pair(*, params: Optional[dict] = None) → PyTravisCI.resource_types.key_pair_generated.KeyPairGenerated[source]

Generates a new RSA key pair.

get_branch(branch_name: str, *, params: Optional[dict] = None) → PyTravisCI.resource_types.branch.Branch[source]

Provides the information of a given branch.

Official Travis CI API documentation:
Parameters:
  • branch_name – Name of the git branch.
  • params – The query parameters to append to the URL.
get_branches(*, params: Optional[dict] = None) → PyTravisCI.resource_types.branches.Branches[source]

Provides the list of branches of the current repository.

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

Provides the list of builds of the current repository.

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

Provides the list of caches of the current repository.

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

Provides the list of crons of the current repository.

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.
get_env_var(env_var_id: str, *, params: Optional[dict] = None) → PyTravisCI.resource_types.env_var.EnvVar[source]

Provides an environment variable from its ID.

Official Travis CI API documentation:
Parameters:
  • env_var_id – The ID of the environment variable to get.
  • params – The query parameters to append to the URL.
get_env_vars(*, params: Optional[dict] = None) → PyTravisCI.resource_types.env_vars.EnvVars[source]

Provides the list of environment variables of the current repository.

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

Provides the RSA key pair of the current repository.

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

Provides the generated RSA key pair of the current repository.

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.
get_request(request_id: Union[str, int], *, params: Optional[dict] = None) → PyTravisCI.resource_types.request.Request[source]

Provides a single request from its given ID.

Official Travis CI API documentation:
Parameters:
  • request_id – The ID of the request to get.
  • params – The query parameters to append to the URL.
get_requests(*, params: Optional[dict] = None) → PyTravisCI.resource_types.requests.Requests[source]

Provides the list of requests of the current repository.

Official Travis CI API documentation:
Parameters:params – The query parameters to append to the URL.
get_setting(setting_name: str, *, params: Optional[dict] = None) → PyTravisCI.resource_types.setting.Setting[source]

Provides a single setting from its given name.

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

Provides the list of settings of the current repository.

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

Stars the current repository.

Parameters:params – The query parameters to append to the URL.
unstar(*, params: Optional[dict] = None) → PyTravisCI.resource_types.repository.Repository[source]

Unstars the current repository.

Parameters:params – The query parameters to append to the URL.

Request

Just another Travis CI (API) Python interface.

A module which provides the “Request” 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.request.Request(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a request.

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the build.
  • state (str) – Current state of the build.
  • result (str) – The result of the request (eg. rejected or approved).
  • message (str) – Travis-ci status message attached to the request.
  • previous_state (str) – State of the previous build (useful to see if state changed).
  • pull_request_mergeable – The request’s pull_request_mergeable.
  • repository (Repository) – GitHub user or organization the build belongs to.
  • branch_name (str) – Name of the branch requested to be built.
  • commit (Commit) – The commit the request is associated with.
  • builds (List[Build]) – The request’s builds.
  • owner – GitHub user or organization the request belongs to.
  • created_at (datetime) – When the build started.
  • event_type (str) – Origin of request (push, pull request, api).
  • base_commit (str) – The base commit the request is associated with.
  • head_commit (str) – The head commit the request is associated with.
  • messages – The request’s messages.
  • config – Build configuration (as parsed from .travis.yml).
  • raw_configs – The request’s raw_configs.

Requests

Just another Travis CI (API) Python interface.

A module which provides the “Requests” 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.requests.Requests(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the list of requests.

Official Travis CI API documentation
Variables:requests – List of requests.

Setting

Just another Travis CI (API) Python interface.

A module which provides the “Setting” 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.setting.Setting(**kwargs)[source]

Provides an individual repository setting.

Official Travis CI API documentation
Variables:
  • name (str) – The settings’s name.
  • value (str) – The settings’s value.
set_value(value: Union[bool, int]) → PyTravisCI.resource_types.setting.Setting[source]

Set the new value of the current setting.

Parameters:value – The new value.

Settings

Just another Travis CI (API) Python interface.

A module which provides the “Settings” 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.settings.Settings(**kwargs)[source]

Provides a list of repository settings.

Official Travis CI API documentation
Variables:settings (List[PyTravisCI.resource_types.setting.Setting]) – A list of setting.

Stage

Just another Travis CI (API) Python interface.

A module which provides the “Stage” 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.stage.Stage(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides the description of a stage

Official Travis CI API documentation
Variables:
  • id (int) – Value uniquely identifying the stage.
  • number (int) – Incremental number for a stage.
  • name (str) – The name of the stage.
  • state (str) – Current state of the stage.
  • started_at (datetime) – When the stage started.
  • finished_at (datetime) – When the stage finished.
  • jobs (List[PyTravisCI.resource_types.job.Job]) – The jobs of a stage.

Stages

Just another Travis CI (API) Python interface.

A module which provides the “Stages” 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.stages.Stages(**kwargs)[source]

Bases: PyTravisCI.resource_types.base.ResourceTypesBase

Provides a list of stage.

Official Travis CI API documentation
Variables:stages (List[PyTravisCI.resource_types.stage.Stage]) – A list of stage.

User

Just another Travis CI (API) Python interface.

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.