Package: evergreen-py
Evergreen.pyA client library for the Evergreen API written in python. Currently supports the V2 version of
the API. For more details, seehttps://github.com/evergreen-ci/evergreen/wiki/REST-V2-Usage.Table of contentsDescriptionGetting HelpDependenciesInstallationUsageDocumentationContributor's GuideSetting up a local development environmentLinting/formattingRunning testsAutomatically running checks on commitVersioningCode ReviewDeploymentDescriptionThis is a Python client library for interacting with Evergreen and Evergreen objects. It currently only
supports the V2 version of Evergreen's api. It can be used either by Python code in a separate application
or on the command line to get data about Evergreen objects quickly and easily.Getting HelpWhat's the right channel to ask my question?If you have a question about evergreen.py, please mention @dag-on-call in
slack channel#evergreen-users,
or email us atdevprod-si-team@mongodb.com.How can I request a change/report a bug in evergreen.py?Create aDEVPROD ticket.What should I include in my ticket or #evergreen-users question?Since #evergreen-users questions are interrupts,
please include as much information as possible.
This can help avoid long information-gathering threads.Please include the following:Motivation for Requestprovide us the motivation for this change.Contextprovide some background contexts for this issue.Descriptionprovide some descriptions on how this issue happened.DependenciesPython 3.9 or laterInstallation$pipinstallevergreen.pyUsageThis client can be used either in code or directly via the command line.In code:>>fromevergreen.apiimportEvgAuth,EvergreenApi>>api=EvergreenApi.get_api(EvgAuth('your.username','***'))>>project=api.project_by_id('mongodb-mongo-master')>>project.display_name'MongoDB (master)'Cli:$evg-api--jsonlist-hosts{"host_id":"host num 0","host_url":"host.num.com","distro":{"distro_id":"ubuntu1804-build","provider":"static","image_id":""},"provisioned":true,"started_by":"mci","host_type":"","user":"mci-exec","status":"running","running_task":{"task_id":null,"name":null,"dispatch_time":null,"version_id":null,"build_id":null},"user_host":false}Thepatch_from_diffAPI requires the Evergreen CLI to be installed.
Add the following to the host's DOCKERFILE:RUNwgethttps://evergreen.mongodb.com/clients/linux_amd64/evergreen
RUNchmod+xevergreen
ENVPATH="/project:$PATH"You will need to provide an .evergreen.yml file with credentials to use the CLI. Assuming you are using theweb-appchart this can be done bymountingkubernetes secretsin your pod.Store the secret in the cluster:kubectlcreatesecretgeneric<secret_name>--from-file.evergreen.yml--namespace<namespace>In environments/deployment.yml configure the file to be mounted and linked to the correct location:volumeSecrets:-name:<secret_name>path:/etc/secretslifecycle:postStart:type:execcommand:-/bin/sh--c-ln -sf /etc/secrets/.evergreen.ymlDocumentationYou can find the documentationhere.Contributor's GuideSetting up a local development environmentRequirementsPoetry 1.1 or laterYou will need Evergreen credentials on your local machine to use this library or the attached CLI. You
can set up your credentials by following the linkhere.Linting/formattingThis project usesblackandisortfor linting/formatting.poetryrunblacksrctests
poetryrunisortsrctestsRunning testspoetryrunpytestThere are a few tests that are slow running. These tests are not run by default, but can be included
by setting the env variable RUN_SLOW_TESTS to any value.$ RUN_SLOW_TEST=1 poetry run pytestTo get code coverage information:$ poetry run pytest --cov=src --cov-report=htmlAutomatically running checks on commitThis project haspre-commitconfigured. Pre-commit will run
configured checks at git commit time. To enable pre-commit on your local repository run:$poetryrunpre-commitinstallVersioningBefore deploying a new version, please update theCHANGELOG.mdfile with a description of what
is being changed.Deployment toPyPiare done automatically on merges to master.
In order to avoid overwriting a previous deploy, the version should be updated on all changes. Thesemverversioning scheme should be used for determining the version number.The version is found in thepyproject.tomlfile.Code ReviewThis project uses theEvergreen Commit Queue.
Add a PR comment withevergreen mergeto trigger a merge.DeploymentDeployment toPyPiis automatically triggered on merges to master.