Skip to content

Commit d6298de

Browse files
committed
The initial commit
0 parents  commit d6298de

37 files changed

+2160
-0
lines changed

.github/CODEOWNERS

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#
2+
# These owners will be the default owners for everything in the repo.
3+
#
4+
* @TGWolf
5+

.github/CODE_OF_CONDUCT.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behaviour that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behaviour by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behaviour and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behaviour.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
58+
reported by contacting the project team at . All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the
71+
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
72+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
73+
74+
For answers to common questions about this code of conduct, see
75+
<https://www.contributor-covenant.org/faq>

.github/CONTRIBUTING.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Contributing
2+
3+
Please refer to the
4+
[contributing](https://github.com/WolfSoftware/contributing)
5+
documentation.
6+
7+
## Important
8+
9+
ALL commits must be signed to ensure the identity of the developer, any pull
10+
requests that are made with unsigned commits will be rejected as a matter of
11+
course.
12+
13+
> This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting
14+
with this repository, organization, or community you agree to abide by its terms.

.github/FUNDING.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Funding
2+
# https://help.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository
3+
4+
github: [WolfSoftware,TGWolf]
+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Ask a question
2+
description: If you don't have a specific issue or bug to report you can still ask us questions and we will do our best to answer them
3+
title: "[Question]: "
4+
labels: ["type: question", "state: triage"]
5+
assignees:
6+
- tgwolf
7+
body:
8+
- type: textarea
9+
id: question
10+
attributes:
11+
label: What is your question?
12+
description: Please give us time to review your question and formulate an answer.
13+
validations:
14+
required: true
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Code of Conduct
19+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/python-snippets/blob/master/.github/CODE_OF_CONDUCT.md)
20+
options:
21+
- label: I agree to follow this project's Code of Conduct
22+
required: true

.github/ISSUE_TEMPLATE/bug_report.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Report a bug
2+
description: Found a bug? Let us knonw what the issue is and we will attempt to fix it
3+
title: "[Bug]: "
4+
labels: ["type: bug", "state: triage"]
5+
assignees:
6+
- tgwolf
7+
body:
8+
- type: textarea
9+
id: what-happened
10+
attributes:
11+
label: What happened?
12+
description: A clear and concise description of what the bug is.
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: expected-behavior
17+
attributes:
18+
label: Expected behavior
19+
description: A clear and concise description of what you expected to happen.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: reproduce
24+
attributes:
25+
label: How do we reproduct the bug?
26+
description: What are the steps we need to take to reproduce the behavior?
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: logs
31+
attributes:
32+
label: Relevant log output
33+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
34+
render: shell
35+
validations:
36+
required: false
37+
- type: textarea
38+
id: screenshoots
39+
attributes:
40+
label: Screeenshots
41+
description: Upload any screenshots that might help demonstrate the bug.
42+
validations:
43+
required: false
44+
- type: textarea
45+
id: additional-information
46+
attributes:
47+
label: Additional information
48+
description: Please provide any additional information that you think will help us to resolve this bug.
49+
validations:
50+
required: false
51+
- type: checkboxes
52+
id: terms
53+
attributes:
54+
label: Code of Conduct
55+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/python-snippets/blob/master/.github/CODE_OF_CONDUCT.md)
56+
options:
57+
- label: I agree to follow this project's Code of Conduct
58+
required: true

.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Support us
4+
url: https://ko-fi.com/wolfsoftware
5+
about: Show your support
6+
- name: Visit our website
7+
url: https://wolfsoftware.com/
8+
about: Visit the Wolf Software website and see what else we do and what services we offer
+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Request a new feature
2+
description: Got an idea for a new feature? Let us know what you want and we will see if we can add it
3+
title: "[Feature Request]: "
4+
labels: ["type: feature", "state: triage"]
5+
assignees:
6+
- tgwolf
7+
body:
8+
- type: textarea
9+
id: releated-to
10+
attributes:
11+
label: Is your feature request related to a problem?
12+
description: A clear and concise description of what the problem is. E.g. I'm always frustrated when ...
13+
validations:
14+
required: true
15+
- type: textarea
16+
id: suggested-solution
17+
attributes:
18+
label: Suggested Solution
19+
description: A clear and concise description of what you want to see implemented.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Describe alternatives you've considered
26+
description: A clear and concise description of any alternative solutions or features you've considered.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: additional-information
31+
attributes:
32+
label: Additional information
33+
description: Please provide any additional information that you think will help us to resolve this bug.
34+
validations:
35+
required: false
36+
- type: checkboxes
37+
id: terms
38+
attributes:
39+
label: Code of Conduct
40+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/DevelopersToolbox/python-snippets/blob/master/.github/CODE_OF_CONDUCT.md)
41+
options:
42+
- label: I agree to follow this project's Code of Conduct
43+
required: true

.github/PULL_REQUEST_TEMPLATE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Thank You
2+
3+
Thanks for submitting a pull request! Please provide enough information so that
4+
others can review your pull request:
5+
6+
## Summary
7+
8+
<!-- Summary of the PR -->
9+
10+
This PR fixes/implements the following **bugs/features**
11+
12+
* [ ] Bug 1
13+
* [ ] Feature 1
14+
* [ ] Breaking changes
15+
16+
<!-- You can skip this if you're fixing a typo or adding an app to the
17+
Showcase. -->
18+
19+
Explain the **motivation** for making this change. What existing problem does
20+
the pull request solve?
21+
22+
<!-- Example: When "Adding a function to do X", explain why it is necessary
23+
to have a way to do X. -->
24+
25+
## Test plan (required)
26+
27+
Demonstrate the code is solid. Example: The exact commands you ran and their
28+
output, screenshots help greatly.
29+
30+
<!-- Make sure tests pass on both Travis. -->
31+
32+
## Closing issues
33+
34+
<!-- Put `fixes #NNN` in your comment to auto-close the issue that your PR
35+
fixes (if such). -->
36+
Fixes #

.github/SECURITY.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policies and Procedures
2+
3+
This document outlines security procedures and general policies for this project.
4+
5+
* [Reporting a Bug](#reporting-a-bug)
6+
* [Disclosure Policy](#disclosure-policy)
7+
* [Comments on this Policy](#comments-on-this-policy)
8+
9+
## Reporting a Bug
10+
11+
We take **ALL** security related bugs and issues very seriously.
12+
13+
If you think you have identified a security related issue, please
14+
[report it immediately](mailto:disclose@wolfsoftware.com) and include
15+
the word "SECURITY" in the subject line. If you are not sure, don’t worry.
16+
Better safe than sorry – just send an email.
17+
18+
* Please provide as much information as you can.
19+
* Please do not open issues related to any security concerns publicly.
20+
* Please do not include anyone else on the disclosure email.
21+
22+
Report security bugs in third-party modules to the person or team maintaining
23+
the module.
24+
25+
## Disclosure Policy
26+
27+
When a security report is received, we will carry out the following steps:
28+
29+
* Confirm the problem and determine the affected versions.
30+
* Audit code to find any potential similar problems.
31+
* Prepare fixes for all releases still under maintenance. These fixes will be
32+
released as fast as possible.
33+
34+
We will endeavour to keep you informed of the progress towards a fix and full
35+
announcement, and may ask for additional information or guidance.
36+
37+
## Comments on this Policy
38+
39+
If you have suggestions on how this process could be improved please submit a
40+
pull request.

.github/dependabot.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
time: "04:00"
10+
open-pull-requests-limit: 10
11+
commit-message:
12+
prefix: "chore:"
13+
labels:
14+
- "dependabot: ecosystem : github actions"
15+
- "dependabot: dependencies"
16+
assignees:
17+
- "TGWolf"
18+
19+
- package-ecosystem: "pip"
20+
directory: "/"
21+
schedule:
22+
interval: "weekly"
23+
time: "04:00"
24+
day: "monday"
25+
open-pull-requests-limit: 10
26+
commit-message:
27+
prefix: "chore:"
28+
labels:
29+
- "dependabot: ecosystem : python"
30+
- "dependabot: dependencies"
31+
assignees:
32+
- "TGWolf"
33+

.github/scripts/check-jobs.sh

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/usr/bin/env bash
2+
3+
# This script receives a JSON string containing job results and checks for any failures.
4+
5+
# Check if jq is available
6+
if ! command -v jq &> /dev/null; then
7+
echo "jq could not be found, please install jq to run this script."
8+
exit 1
9+
fi
10+
11+
# Read the JSON string from the first script argument
12+
job_results_json=$1
13+
14+
# Check if the job results JSON is not empty
15+
if [[ -z "$job_results_json" ]]; then
16+
echo "No job results JSON provided."
17+
exit 1
18+
fi
19+
20+
# Set default state
21+
failed_jobs=false
22+
23+
# Use jq to parse the JSON and check each job's result
24+
while IFS= read -r line; do
25+
job_name=$(echo "$line" | awk '{print $1}')
26+
result=$(echo "$line" | awk '{print $3}')
27+
28+
if [ "$result" != "success" ]; then
29+
echo "$job_name failed."
30+
failed_jobs=true
31+
else
32+
echo "$job_name succeed."
33+
fi
34+
done <<< "$( echo "$job_results_json" | jq -r 'to_entries[] | "\(.key) result: \(.value.result)"' )"
35+
36+
if [ "$failed_jobs" = true ] ; then
37+
exit 1
38+
fi

0 commit comments

Comments
 (0)