Skip to content

Commit a7ca269

Browse files
bdracobdraco
committed
chore: initial commit
0 parents  commit a7ca269

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1602
-0
lines changed

‎.all-contributorsrc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"projectName": "aiousbwatcher",
3+
"projectOwner": "bluetooth-devices",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 80,
10+
"commit": true,
11+
"commitConvention": "angular",
12+
"contributors": [],
13+
"contributorsPerLine": 7,
14+
"skipCi": true
15+
}

‎.codespellrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[codespell]
2+
ignore-words-list = socio-economic

‎.copier-answers.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changes here will be overwritten by Copier
2+
_commit: 7a308a7
3+
_src_path: https://github.com/browniebroke/pypackage-template
4+
add_me_as_contributor: false
5+
copyright_year: '2025'
6+
documentation: true
7+
email: bluetooth@koston.org
8+
full_name: J. Nick Koston
9+
github_username: bluetooth-devices
10+
has_cli: false
11+
initial_commit: true
12+
is_django_package: false
13+
open_source_license: MIT
14+
package_name: aiousbwatcher
15+
project_name: asyncio usb device watcher
16+
project_short_description: Watch for USB devices to be plugged and unplugged
17+
project_slug: aiousbwatcher
18+
run_uv_sync: true
19+
setup_github: true
20+
setup_pre_commit: true
21+

‎.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.bat]
14+
indent_style = tab
15+
end_of_line = crlf
16+
17+
[LICENSE]
18+
insert_final_newline = false
19+
20+
[Makefile]
21+
indent_style = tab

‎.github/CODE_OF_CONDUCT.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported by contacting @bluetooth-devices. All complaints will be reviewed and
63+
investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series
85+
of actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or
92+
permanent ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within
112+
the community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.0, available at
118+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
120+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121+
enforcement ladder](https://github.com/mozilla/diversity).
122+
123+
[homepage]: https://www.contributor-covenant.org
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
https://www.contributor-covenant.org/faq. Translations are available at
127+
https://www.contributor-covenant.org/translations.

‎.github/FUNDING.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: ["bluetooth-devices"]

‎.github/ISSUE_TEMPLATE/1-bug-report.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Describe the bug
9+
description: A clear and concise description of what the bug is.
10+
placeholder: Describe the bug
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: reproduce
15+
attributes:
16+
label: To Reproduce
17+
description: Steps to reproduce the behavior.
18+
placeholder: To Reproduce
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: context
23+
attributes:
24+
label: Additional context
25+
description: Add any other context about the problem here.
26+
placeholder: Additional context
27+
- type: input
28+
id: version
29+
attributes:
30+
label: Version
31+
description: Version of the project.
32+
placeholder: Version
33+
validations:
34+
required: true
35+
- type: input
36+
id: platform
37+
attributes:
38+
label: Platform
39+
description: Platform where the bug was found.
40+
placeholder: "Example: Windows 11 / macOS 12.0.1 / Ubuntu 20.04"
41+
validations:
42+
required: true
43+
- type: checkboxes
44+
id: terms
45+
attributes:
46+
label: Code of Conduct
47+
description: By submitting this issue, you agree to follow our
48+
[Code of Conduct](https://github.com/bluetooth-devices/aiousbwatcher/blob/main/.github/CODE_OF_CONDUCT.md).
49+
options:
50+
- label: I agree to follow this project's Code of Conduct.
51+
required: true
52+
- type: checkboxes
53+
id: no-duplicate
54+
attributes:
55+
label: No Duplicate
56+
description: Please check [existing issues](https://github.com/bluetooth-devices/aiousbwatcher/issues) to avoid duplicates.
57+
options:
58+
- label: I have checked existing issues to avoid duplicates.
59+
required: true
60+
- type: markdown
61+
attributes:
62+
value: 👋 Have a great day and thank you for the bug report!

‎.github/ISSUE_TEMPLATE/2-feature-request.yml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Is your feature request related to a problem? Please describe.
9+
description: A clear and concise description of what the problem is.
10+
value: I'm always frustrated when
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: solution
15+
attributes:
16+
label: Describe alternatives you've considered
17+
description: A clear and concise description of any alternative solutions or features you've considered.
18+
placeholder: Describe alternatives you've considered
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: context
23+
attributes:
24+
label: Additional context
25+
description: Add any other context or screenshots about the feature request here.
26+
placeholder: Additional context
27+
- type: checkboxes
28+
id: terms
29+
attributes:
30+
label: Code of Conduct
31+
description: By submitting this issue, you agree to follow our
32+
[Code of Conduct](https://github.com/bluetooth-devices/aiousbwatcher/blob/main/.github/CODE_OF_CONDUCT.md).
33+
options:
34+
- label: I agree to follow this project's Code of Conduct
35+
required: true
36+
- type: checkboxes
37+
id: willing
38+
attributes:
39+
label: Are you willing to resolve this issue by submitting a Pull Request?
40+
description: Remember that first-time contributors are welcome! 🙌
41+
options:
42+
- label: Yes, I have the time, and I know how to start.
43+
- label: Yes, I have the time, but I don't know how to start. I would need guidance.
44+
- label: No, I don't have the time, although I believe I could do it if I had the time...
45+
- label: No, I don't have the time and I wouldn't even know how to start.
46+
- type: markdown
47+
attributes:
48+
value: 👋 Have a great day and thank you for the feature request!

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Disabling blank issues to ensure all necessary information is provided
2+
# Users should use the provided templates for specific issues
3+
# For general questions, please refer to the contact links section
4+
blank_issues_enabled: false
5+
contact_links:
6+
- name: Questions
7+
url: https://github.com/bluetooth-devices/aiousbwatcher/discussions/categories/q-a
8+
about: Please ask and answer questions here.

‎.github/PULL_REQUEST_TEMPLATE.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
😀 Wonderful! Thank you for opening a pull request.
3+
4+
By submitting this pull request, you agree to follow our [Code of Conduct](https://github.com/bluetooth-devices/aiousbwatcher/blob/main/.github/CODE_OF_CONDUCT.md).
5+
6+
Please fill in the information below to expedite the review
7+
and (hopefully) merge of your change.
8+
-->
9+
10+
### Description of change
11+
12+
<!--
13+
Please be clear and concise what the change is intended to do,
14+
why this change is needed, and how you've verified that it
15+
corrects what you intended.
16+
17+
In some cases it may be helpful to include the current behavior
18+
and the new behavior.
19+
20+
If the change is related to an open issue, you can link it here.
21+
If you include `Fixes #0000` (replacing `0000` with the issue number)
22+
when this is merged it will automatically mark the issue as fixed and
23+
close it.
24+
-->
25+
26+
### Pull-Request Checklist
27+
28+
<!--
29+
Please make sure to review and check all of the following to merge this PR.
30+
31+
Note that there is no problem if they are not checked when this PR is created.
32+
33+
If an item is not applicable, you can add "N/A" to the end.
34+
-->
35+
36+
- [ ] Code is up-to-date with the `main` branch
37+
- [ ] This pull request follows the [contributing guidelines](https://github.com/bluetooth-devices/aiousbwatcher/blob/main/CONTRIBUTING.md).
38+
- [ ] This pull request links relevant issues as `Fixes #0000`
39+
- [ ] There are new or updated unit tests validating the change
40+
- [ ] Documentation has been updated to reflect this change
41+
- [ ] The new commits follow conventions outlined in the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/), such as "fix(api): prevent racing of requests".
42+
43+
> - If pre-commit.ci is failing, try `pre-commit run -a` for further information.
44+
> - If CI / test is failing, try `uv run pytest` for further information.
45+
46+
<!--
47+
🎉 Thank you for contributing!
48+
-->

0 commit comments

Comments
 (0)