Metadata-Version: 2.1
Name: ops-py-github-tools
Version: 1.1.4
Summary: Selection of tools to use with GitHub
License: MIT License
        
        Copyright (c) 2024 Equinor
        
        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.
        
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi==2024.2.2
Requires-Dist: charset-normalizer==3.3.2
Requires-Dist: idna==3.6
Requires-Dist: pip==24.0
Requires-Dist: requests==2.31.0
Requires-Dist: setuptools==69.1.1
Requires-Dist: urllib3==2.2.1

# ops-py-github-tools

## Description 
A collection of various GitHub Tools:    
  - Create or get GitHub Repo Milestones
  - Get GitHub repo Pull Requests info    
  - Create GitHub repo issue templates      
  - Perform requests to GitHub

    
## Installation `pip install ops-py-github-tools`      

## Usage    
  Please refer to [github_tools_examples.py](src%2Fgithub_tools%2Fgithub_tools_examples.py)


### Create desired template based on the title of the GitHub Issue

**Example:**   
```
python3 -m github_tools.github_issue_templates --title "📇 mc-isb: Monitoring documentation" --templates_dir .github/ISSUE_TEMPLATE \
     --template_filenames c_epic.md c_epic_maintenance.md d_collection.md d_collection_maintenance.md e_task.md --team_alias myt --team_name "My Team" \
     --team_alias_placeholder "<team_alias>" --team_name_placeholder "<team_name>" \
     --write_templates "" --templates_version v2.0.1 > template.md
```

**Example output:**     
``` 
cat template.md 
---
name: "\U0001f4c7 Collection"
about: "Group(s) of tasks"
title: "\U0001f4c7 c-myt:"
version: "v2.0.1"
---

## Purpose

> Remember the goal type of your tasks here. If any existing tasks are related to another :trophy: Goal type, they should be moved to respective :crown: Epic ->  inside that specific :card_index: collection.

### Summary

DevOps link: `none` / AB#ticketNumber

This collection includes tasks related to..... <!-- Summarise overall reason for tasks in this collection -->

#### Acceptance Criteria

- None

#### Task(s)

- [ ] None

#### Pull Requests

- [ ] None


```
