Skip to content

Commit a8a833a

Browse files
saidsefsaidsef
committed
init commit
0 parents  commit a8a833a

File tree

11 files changed

+1198
-0
lines changed

11 files changed

+1198
-0
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/python
3+
{
4+
"name": "Python 3",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye"
7+
8+
// Features to add to the dev container. More info: https://containers.dev/features.
9+
// "features": {},
10+
11+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
12+
// "forwardPorts": [],
13+
14+
// Use 'postCreateCommand' to run commands after the container is created.
15+
// "postCreateCommand": "pip3 install --user -r requirements.txt",
16+
17+
// Configure tool-specific properties.
18+
// "customizations": {},
19+
20+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
21+
// "remoteUser": "root"
22+
}

‎.github/dependabot.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for more information:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
# https://containers.dev/guide/dependabot
6+
7+
version: 2
8+
updates:
9+
- package-ecosystem: "devcontainers"
10+
directory: "/"
11+
schedule:
12+
interval: weekly
13+
14+
- package-ecosystem: "github-actions"
15+
directory: "/"
16+
schedule:
17+
interval: "weekly"
18+
pull-request-branch-name:
19+
separator: "-"
20+
21+
- package-ecosystem: "pip"
22+
directory: "/"
23+
schedule:
24+
interval: "weekly"
25+
pull-request-branch-name:
26+
separator: "-"

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.python-version .venv/ __pycache__/

‎CONTRIBUTING.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
4+
5+
Please note we have a code of conduct, please follow it in all your interactions with the project.
6+
7+
## Pull Request Process
8+
9+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
10+
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
11+
3. Increase the version numbers is managed by the GitHub Actions CI workflow `tagging.yml`
12+
4. You may merge the Pull Request in once you have the sign-off of from the project team, or if you do not have permission to do that, you may request a reviewer to merge it for you.
13+
14+
## Benchmark
15+
16+
If you are working on a feature that is likely to impact performance, consider running benchmarks and comparing the results before and after your change.
17+
18+
To run benchmarks, run the command:
19+
20+
```shell
21+
go test -run=^$ -bench=. .
22+
```
23+
24+
## Code of Conduct
25+
26+
### Our Pledge
27+
28+
In the interest of fostering an open and welcoming environment, we as
29+
contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
30+
31+
### Our Standards
32+
33+
Examples of behavior that contributes to creating a positive environment include:
34+
35+
* Using welcoming and inclusive language
36+
* Being respectful of differing viewpoints and experiences
37+
* Gracefully accepting constructive criticism
38+
* Focusing on what is best for the community
39+
* Showing empathy towards other community members
40+
41+
Examples of unacceptable behavior by participants include:
42+
43+
* The use of sexualized language or imagery and unwelcome sexual attention or
44+
advances
45+
* Trolling, insulting/derogatory comments, and personal or political attacks
46+
* Public or private harassment
47+
* Publishing others' private information, such as a physical or electronic
48+
address, without explicit permission
49+
* Other conduct which could reasonably be considered inappropriate in a
50+
professional setting
51+
52+
### Our Responsibilities
53+
54+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
55+
56+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
57+
58+
### Scope
59+
60+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
61+
62+
### Enforcement
63+
64+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
65+
66+
Further details of specific enforcement policies may be posted separately.
67+
68+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
69+
70+
### Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/

‎LICENSE.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# Apache License, Version 2.0
2+
3+
[Version 2.0, January 2004](https://www.apache.org/licenses/LICENSE-2.0)
4+
5+
## Terms and Conditions for use, reproduction, and distribution
6+
7+
### 1. Definitions
8+
9+
“License” shall mean the terms and conditions for use, reproduction, and
10+
distribution as defined by Sections 1 through 9 of this document.
11+
12+
“Licensor” shall mean the copyright owner or entity authorized by the copyright
13+
owner that is granting the License.
14+
15+
“Legal Entity” shall mean the union of the acting entity and all other entities
16+
that control, are controlled by, or are under common control with that entity.
17+
For the purposes of this definition, “control” means **(i)** the power, direct or
18+
indirect, to cause the direction or management of such entity, whether by
19+
contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
20+
outstanding shares, or **(iii)** beneficial ownership of such entity.
21+
22+
“You” (or “Your”) shall mean an individual or Legal Entity exercising
23+
permissions granted by this License.
24+
25+
“Source” form shall mean the preferred form for making modifications, including
26+
but not limited to software source code, documentation source, and configuration
27+
files.
28+
29+
“Object” form shall mean any form resulting from mechanical transformation or
30+
translation of a Source form, including but not limited to compiled object code,
31+
generated documentation, and conversions to other media types.
32+
33+
“Work” shall mean the work of authorship, whether in Source or Object form, made
34+
available under the License, as indicated by a copyright notice that is included
35+
in or attached to the work (an example is provided in the Appendix below).
36+
37+
“Derivative Works” shall mean any work, whether in Source or Object form, that
38+
is based on (or derived from) the Work and for which the editorial revisions,
39+
annotations, elaborations, or other modifications represent, as a whole, an
40+
original work of authorship. For the purposes of this License, Derivative Works
41+
shall not include works that remain separable from, or merely link (or bind by
42+
name) to the interfaces of, the Work and Derivative Works thereof.
43+
44+
“Contribution” shall mean any work of authorship, including the original version
45+
of the Work and any modifications or additions to that Work or Derivative Works
46+
thereof, that is intentionally submitted to Licensor for inclusion in the Work
47+
by the copyright owner or by an individual or Legal Entity authorized to submit
48+
on behalf of the copyright owner. For the purposes of this definition,
49+
“submitted” means any form of electronic, verbal, or written communication sent
50+
to the Licensor or its representatives, including but not limited to
51+
communication on electronic mailing lists, source code control systems, and
52+
issue tracking systems that are managed by, or on behalf of, the Licensor for
53+
the purpose of discussing and improving the Work, but excluding communication
54+
that is conspicuously marked or otherwise designated in writing by the copyright
55+
owner as “Not a Contribution.”
56+
57+
“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
58+
of whom a Contribution has been received by Licensor and subsequently
59+
incorporated within the Work.
60+
61+
### 2. Grant of Copyright License
62+
63+
Subject to the terms and conditions of this License, each Contributor hereby
64+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
65+
irrevocable copyright license to reproduce, prepare Derivative Works of,
66+
publicly display, publicly perform, sublicense, and distribute the Work and such
67+
Derivative Works in Source or Object form.
68+
69+
### 3. Grant of Patent License
70+
71+
Subject to the terms and conditions of this License, each Contributor hereby
72+
grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
73+
irrevocable (except as stated in this section) patent license to make, have
74+
made, use, offer to sell, sell, import, and otherwise transfer the Work, where
75+
such license applies only to those patent claims licensable by such Contributor
76+
that are necessarily infringed by their Contribution(s) alone or by combination
77+
of their Contribution(s) with the Work to which such Contribution(s) was
78+
submitted. If You institute patent litigation against any entity (including a
79+
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
80+
Contribution incorporated within the Work constitutes direct or contributory
81+
patent infringement, then any patent licenses granted to You under this License
82+
for that Work shall terminate as of the date such litigation is filed.
83+
84+
### 4. Redistribution
85+
86+
You may reproduce and distribute copies of the Work or Derivative Works thereof
87+
in any medium, with or without modifications, and in Source or Object form,
88+
provided that You meet the following conditions:
89+
90+
- **(a)** You must give any other recipients of the Work or Derivative Works a copy of
91+
this License; and
92+
- **(b)** You must cause any modified files to carry prominent notices stating that You
93+
changed the files; and
94+
- **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
95+
all copyright, patent, trademark, and attribution notices from the Source form
96+
of the Work, excluding those notices that do not pertain to any part of the
97+
Derivative Works; and
98+
- **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
99+
Derivative Works that You distribute must include a readable copy of the
100+
attribution notices contained within such NOTICE file, excluding those notices
101+
that do not pertain to any part of the Derivative Works, in at least one of the
102+
following places: within a NOTICE text file distributed as part of the
103+
Derivative Works; within the Source form or documentation, if provided along
104+
with the Derivative Works; or, within a display generated by the Derivative
105+
Works, if and wherever such third-party notices normally appear. The contents of
106+
the NOTICE file are for informational purposes only and do not modify the
107+
License. You may add Your own attribution notices within Derivative Works that
108+
You distribute, alongside or as an addendum to the NOTICE text from the Work,
109+
provided that such additional attribution notices cannot be construed as
110+
modifying the License.
111+
112+
You may add Your own copyright statement to Your modifications and may provide
113+
additional or different license terms and conditions for use, reproduction, or
114+
distribution of Your modifications, or for any such Derivative Works as a whole,
115+
provided Your use, reproduction, and distribution of the Work otherwise complies
116+
with the conditions stated in this License.
117+
118+
### 5. Submission of Contributions
119+
120+
Unless You explicitly state otherwise, any Contribution intentionally submitted
121+
for inclusion in the Work by You to the Licensor shall be under the terms and
122+
conditions of this License, without any additional terms or conditions.
123+
Notwithstanding the above, nothing herein shall supersede or modify the terms of
124+
any separate license agreement you may have executed with Licensor regarding
125+
such Contributions.
126+
127+
### 6. Trademarks
128+
129+
This License does not grant permission to use the trade names, trademarks,
130+
service marks, or product names of the Licensor, except as required for
131+
reasonable and customary use in describing the origin of the Work and
132+
reproducing the content of the NOTICE file.
133+
134+
### 7. Disclaimer of Warranty
135+
136+
Unless required by applicable law or agreed to in writing, Licensor provides the
137+
Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
138+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
139+
including, without limitation, any warranties or conditions of TITLE,
140+
NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
141+
solely responsible for determining the appropriateness of using or
142+
redistributing the Work and assume any risks associated with Your exercise of
143+
permissions under this License.
144+
145+
### 8. Limitation of Liability
146+
147+
In no event and under no legal theory, whether in tort (including negligence),
148+
contract, or otherwise, unless required by applicable law (such as deliberate
149+
and grossly negligent acts) or agreed to in writing, shall any Contributor be
150+
liable to You for damages, including any direct, indirect, special, incidental,
151+
or consequential damages of any character arising as a result of this License or
152+
out of the use or inability to use the Work (including but not limited to
153+
damages for loss of goodwill, work stoppage, computer failure or malfunction, or
154+
any and all other commercial damages or losses), even if such Contributor has
155+
been advised of the possibility of such damages.
156+
157+
### 9. Accepting Warranty or Additional Liability
158+
159+
While redistributing the Work or Derivative Works thereof, You may choose to
160+
offer, and charge a fee for, acceptance of support, warranty, indemnity, or
161+
other liability obligations and/or rights consistent with this License. However,
162+
in accepting such obligations, You may act only on Your own behalf and on Your
163+
sole responsibility, not on behalf of any other Contributor, and only if You
164+
agree to indemnify, defend, and hold each Contributor harmless for any liability
165+
incurred by, or claims asserted against, such Contributor by reason of your
166+
accepting any such warranty or additional liability.

0 commit comments

Comments
 (0)