Skip to content

Commit 2e4a263

Browse files
SauravMaheshkarSauravMaheshkar
authored
Initial commit
0 parents  commit 2e4a263

16 files changed

+419
-0
lines changed

‎.devcontainer/devcontainer.json

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{
2+
"name": "Python Project Template",
3+
"build": {
4+
"dockerfile": "./Containerfile",
5+
"context": "."
6+
},
7+
"features": {
8+
"ghcr.io/devcontainers/features/common-utils:2": {
9+
"installZsh": true,
10+
"configureZshAsDefaultShell": true,
11+
"upgradePackages": true
12+
},
13+
"ghcr.io/devcontainers/features/git:1": {
14+
"version": "latest",
15+
"ppa": false
16+
},
17+
"ghcr.io/devcontainers/features/github-cli:1": {},
18+
"ghcr.io/devcontainers/features/python:1": {
19+
"version": "3.8",
20+
"installTools": true
21+
}
22+
},
23+
"customizations": {
24+
"vscode": {
25+
"extensions": [
26+
"bungcip.better-toml",
27+
"github.copilot",
28+
"ms-azuretools.vscode-docker",
29+
"charliermarsh.ruff",
30+
"ms-python.python",
31+
"ms-python.vscode-pylance",
32+
"ms-vscode-remote.remote-containers",
33+
"ms-vscode-remote.remote-ssh",
34+
"ms-vscode-remote.remote-ssh-edit",
35+
"redhat.vscode-yaml",
36+
"tonybaloney.vscode-pets",
37+
"vscode-icons-team.vscode-icons"
38+
],
39+
"settings": {
40+
"python.analysis.typeCheckingMode": "basic",
41+
"python.linting.enabled": true,
42+
"python.testing.pytestArgs": [
43+
"tests"
44+
],
45+
"python.testing.unittestEnabled": false,
46+
"python.testing.pytestEnabled": true,
47+
"editor.fontSize": 16,
48+
"editor.suggestSelection": "first",
49+
"editor.formatOnSaveMode": "file",
50+
"editor.formatOnSave": true,
51+
"editor.inlineSuggest.enabled": true,
52+
"editor.codeActionsOnSave": {
53+
"source.organizeImports": true,
54+
"source.fixAll": true
55+
},
56+
"workbench.editorAssociations": {
57+
"*.ipynb": "jupyter-notebook"
58+
},
59+
"workbench.iconTheme": "vscode-icons"
60+
}
61+
}
62+
},
63+
"postCreateCommand": "make requirements",
64+
"remoteUser": "root"
65+
}

‎.devcontainer/requirements.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
black
2+
mypy>=0.900
3+
numpy>=1.22.0
4+
pre-commit>=2.18.0
5+
pytest>=6.0.0
6+
ruff
7+
scipy>=1.10.0

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @SauravMaheshkar

‎.github/CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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 to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.github/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# python-template
2+
General Purpose Repository Template for Python Projects

‎.github/codeql/codeql-config.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
paths:
2+
- src
3+
paths-ignore:
4+
- 'tests/**'

‎.github/dependabot.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "pip"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
- package-ecosystem: "github-actions"
8+
directory: "/"
9+
schedule:
10+
interval: "daily"

‎.github/workflows/codeql-analysis.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: "CodeQL"
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
paths:
7+
- '**.py'
8+
pull_request:
9+
branches: [ main ]
10+
paths:
11+
- '**.py'
12+
release:
13+
types: [ created ]
14+
schedule:
15+
- cron: "0 0 * * 0"
16+
17+
jobs:
18+
analyze:
19+
name: Analyze
20+
runs-on: ubuntu-latest
21+
permissions:
22+
security-events: write
23+
24+
steps:
25+
- name: Checkout repository
26+
uses: actions/checkout@v4
27+
28+
- name: Initialize CodeQL
29+
uses: github/codeql-action/init@v3
30+
with:
31+
config-file: ./.github/codeql/codeql-config.yml
32+
languages: python
33+
setup-python-dependencies: true
34+
35+
- name: Perform CodeQL Analysis
36+
uses: github/codeql-action/analyze@v3

‎.github/workflows/python.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: "Build and Tests"
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "**.py"
8+
- ".devcontainer/requirements.txt"
9+
- ".github/workflows/python.yml"
10+
pull_request:
11+
branches: [main]
12+
paths:
13+
- "**.py"
14+
- ".devcontainer/requirements.txt"
15+
- ".github/workflows/python.yml"
16+
release:
17+
types: [created]
18+
schedule:
19+
- cron: "0 0 * * 0"
20+
21+
jobs:
22+
build:
23+
runs-on: ${{ matrix.os }}
24+
25+
strategy:
26+
matrix:
27+
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
28+
os: [ubuntu-latest, macos-latest]
29+
30+
steps:
31+
- uses: actions/checkout@v4
32+
- name: Setup Python ${{ matrix.python-version }}
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: ${{ matrix.python-version }}
36+
cache: "pip"
37+
cache-dependency-path: ".devcontainer/requirements.txt"
38+
39+
- name: Install dependencies
40+
run: |
41+
python -m venv .venv && export PATH=".venv/bin:$PATH"
42+
python -m pip install uv
43+
python -m uv pip install --upgrade wheel setuptools
44+
python -m uv pip install -r .devcontainer/requirements.txt
45+
- name: Ruff
46+
run: |
47+
python -m venv .venv && export PATH=".venv/bin:$PATH"
48+
python -m ruff check src
49+
- name: Test with PyTest
50+
run: |
51+
python -m venv .venv && export PATH=".venv/bin:$PATH"
52+
python -m pytest -v .

‎.gitignore

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
**/__pycache__/
2+
**/*.ipynb_checkpoints
3+
**/*.egg-info
4+
*.pyc
5+
.pytest_cache/
6+
.mypy_cache/
7+
.ruff_cache/
8+
9+
venv/
10+
data/
11+
models/
12+
notebooks/
13+
14+
**/.DS_Store

‎.pre-commit-config.yaml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.6.0
4+
hooks:
5+
- id: end-of-file-fixer
6+
- id: trailing-whitespace
7+
- id: check-yaml
8+
- id: check-toml
9+
- id: check-json
10+
- id: check-merge-conflict
11+
- id: requirements-txt-fixer
12+
- id: detect-private-key
13+
- repo: https://github.com/psf/black
14+
rev: 24.8.0
15+
hooks:
16+
- id: black
17+
- repo: https://github.com/pre-commit/mirrors-mypy
18+
rev: v1.11.2
19+
hooks:
20+
- id: mypy
21+
- repo: https://github.com/astral-sh/ruff-pre-commit
22+
rev: v0.6.2
23+
hooks:
24+
- id: ruff

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Saurav Maheshkar
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)