https://github.com/marcpage/devops-driver
DevOps tools
https://github.com/marcpage/devops-driver
azure azure-devops devops devops-pipeline devops-tools devops-workflow email pipelines
Last synced: 7 days ago
JSON representation
DevOps tools
- Host: GitHub
- URL: https://github.com/marcpage/devops-driver
- Owner: marcpage
- License: unlicense
- Created: 2023-10-29T11:13:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-21T11:39:28.000Z (14 days ago)
- Last Synced: 2025-04-27T18:07:03.845Z (8 days ago)
- Topics: azure, azure-devops, devops, devops-pipeline, devops-tools, devops-workflow, email, pipelines
- Language: Python
- Homepage: https://pypi.org/project/devopsdriver/
- Size: 290 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.org/project/devopsdriver/0.1.48/)
[](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
[](https://github.com/marcpage/devops-driver/graphs/contributors)
[](http://makeapullrequest.com)
[](https://github.com/marcpage/devops-driver/commits)
[](https://github.com/marcpage/devops-driver/commits)
[](https://github.com/marcpage/devops-driver)
[](https://github.com/marcpage/devops-driver)
[](https://github.com/marcpage/devops-driver/actions/workflows/pr.yml)
[](https://github.com/marcpage/devops-driver/blob/main/Makefile#L4)
[](https://github.com/marcpage/devops-driver/issues)
[](https://github.com/marcpage/devops-driver/pulls)
[](https://github.com/marcpage?tab=followers)
[](https://github.com/marcpage/devops-driver/watchers)
[](https://python.org/)
[](https://azure.microsoft.com/)
[](https://gmail.com/)
OS:
[](https://microsoft.com/)
[](https://apple.com/)
[](https://linux.org/)
# devops-driver
Devops-driver is a collection of tools to help streamline developer's experience and gain insights into various processes.
## Tools
devopsdriver is a toolbox that helps to quickly put together reports. Some of the items in the toolbox are:
- **Settings**: store data, constants, settings, keys, tokens, etc. both in and out of the repository
- **send_email**: send emails over SMTP (including SSL), using `Settings` to store credentials
- **Template**: Simplify generating reports using `.mako` templates
- **Azure.workitem**: Search for and inspect Azure DevOps work items
## Example use-case
To allow seamless work in both pipelines as well as in the development environment, the `Settings` object gives you access to common settings among multiple scripts, secrets, and configuration constants in a way the helps keep secrets out of the repository but runs just as well in the pipeline as your machine.
Say you want a pipeline that looks for User Stories that are newer than 3 days and send out an email.
### \/devopsdriver.yml
```yaml
smtp:
sender: [email protected]
secrets:
azure.token: azure/token
smtp.password: smtp/password
```
This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development.
| Platform | Global Directory |
|----------|------------------------|
| Windows | %APPDATA%\ |
| Linux | ~/.devopsdriver/ |
| macOS | ~/Library/Preferences/ |
The `secrets` are extra sensative and are stored in the OS keychain.
### Set secrets in the keychain
```bash
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install devopsdriver
$ settings --secrets
secret: smtp.password key: smtp/password
smtp.password (smtp/password): ****
secret: azure.token key: azure/token
smtp.password (azure/token): ****
$ settings --secrets
secret: azure.token key: azure/token
Value set
secret: smtp.password key: smtp/password
Value set
$
```
The first call to `settings` will look for every secret and check if they are already set in the keychain.
For any secret that has not been set in the keychain, you will be prompted to enter the password to store.
The second call to `settings` will verify that all the values have been set in the keychain.
### devopsdriver.yml
```yaml
azure:
url: https://dev.azure.com/MyCompany
smtp:
server: smtp.company.com
port: 465
cli:
azure.token: --azure-token
smtp.password: --smtp-password
smtp.sender: --smtp-sender
env:
azure.token: AZURE_TOKEN
smtp.sender: SMTP_SENDER
smtp.password: SMTP_PASSWORD
```
This file lives next to your scripts in your repository.
These are settings that would be used by everyone, including the pipeline.
The `cli` and `env` map command line switches and environment variables to those keys.
This allows for many options for setting values depending on your needs.
### new_stories.yml
```yaml
scrum masters:
- [email protected]
- [email protected]
```
This file is specific to your script and not shared.
These are values that you want to use in your script but have them here for easy adjustment.
### new_stories.html.mako
```html
Stories created in the last ${days} days
- ${story.id} ${story.title}
% for story in stories:
% endfor
```
This file is the template for the email body.
### new_stories.py
```python
from datetime import date, timedelta
from devopsdriver import Settings, Azure, send_email, Template
from devopsdriver.azdo import Wiql, GreaterThan
# Parse all the settings from files, command line, environment, and keychain
settings = Settings(__file__).key("secrets").cli("cli").env("env")
# Create connection to Azure Devops
azure = Azure(settings)
# Get User Stories created in the last three days
three_days_ago = date.today() - timedelta(days=settings["days of recent stories"])
new_stories = azure.workitem.find(
Wiql().where(GreaterThan("CreatedDate", three_days_ago))
)
# Generate html body of the email
message = Template(__file__).render(
days=settings["days of recent stories"],
stories=new_stories,
)
# Send the email
send_email(
recipients=settings["scrum masters"],
subject=f'Stories created in the last {settings["days of recent stories"]} days',
html_body=message,
settings=settings,
)
```
### The email sent
**From**: [email protected]
**To**: [email protected], [email protected]
**Subject**: Stories created in the last 3 days
#### Stories created in the last 3 days
- 745 Needs a preprocessing step that makes it case insensitive
- 749 Create GitHub action to automate process
- 750 Create GitHub action to automate process
- 751 Test
- 752 Feedback Capture
- 753 draft doc history retrieval method
- 754 frontend - store to schema
- 755 Transfer job to production. Setup migrations to move to production
- 756 Query subscription status from App