Skip to content

Commit 6f2749e

Browse files
semuadminsemuadmin
committed
Initial flattened commit
0 parents  commit 6f2749e

80 files changed

Lines changed: 10327 additions & 0 deletions

Some content is hidden

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

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# pymandel Pull Request Template
2+
3+
## Description
4+
5+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
6+
7+
Fixes # (issue)
8+
9+
## Testing
10+
11+
Please test all changes, however trivial, against the supplied pytest suite `tests/test_*.py`. Please describe any test cases you have amended or added to this suite to maintain code coverage.
12+
13+
- [ ] Test A
14+
- [ ] Test B
15+
16+
## Checklist:
17+
18+
- [ ] I agree to abide by the code of conduct (see [CODE_OF_CONDUCT.md](https://github.com/semuconsulting/pymandel/blob/master/CODE_OF_CONDUCT.md)).
19+
- [ ] My code follows the style guidelines of this project (see [CONTRIBUTING.MD](https://github.com/semuconsulting/pymandel/blob/master/CONTRIBUTING.md)).
20+
- [ ] I have performed a self-review of my own code.
21+
- [ ] (*if appropriate*) I have cited my u-blox documentation source(s).
22+
- [ ] I have commented my code, particularly in hard-to-understand areas.
23+
- [ ] I have made corresponding changes to the documentation.
24+
- [ ] (*if appropriate*) I have added test cases to the `tests/test_*.py` unittest suite to maintain code coverage.
25+
- [ ] I have tested my code against the full `tests/test_*.py` unittest suite.
26+
- [ ] My changes generate no new warnings.
27+
- [ ] Any dependent changes have been merged and published in downstream modules.
28+
- [ ] I have [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) my commits.
29+
- [ ] I understand and acknowledge that the code will be published under a GPLv3 license.

‎.github/workflows/main.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: pymandel
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
strategy:
12+
matrix:
13+
python-version: [3.8, 3.9, "3.10", "3.11"]
14+
15+
steps:
16+
- uses: actions/checkout@v3
17+
- name: Set up Python ${{ matrix.python-version }}
18+
uses: actions/setup-python@v4
19+
with:
20+
python-version: ${{ matrix.python-version }}
21+
- name: Install deploy dependencies
22+
run: |
23+
pip install .[deploy]
24+
- name: Install test dependencies
25+
run: |
26+
pip install .[test]
27+
- name: Install code dependencies
28+
run: |
29+
pip install .
30+
- name: Lint with pylint
31+
run: |
32+
pylint -E src
33+
- name: Security vulnerability analysis with bandit
34+
run: |
35+
bandit -c pyproject.toml -r .
36+
- name: Test with pytest
37+
run: |
38+
pytest

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.DS_Store
2+
.dropbox
3+
.project
4+
.coverage
5+
.pydevproject
6+
*.code-workspace
7+
.settings
8+
/build
9+
/dist
10+
/htmlcov
11+
/docs/_build
12+
/docs/_static
13+
/docs/_templates
14+
pymandel-*/
15+
/__pycache__
16+
/src/pymandel/__pycache__
17+
/src/colormaps/__pycache__
18+
/src/pymandel.egg-info/
19+
*.pyc
20+
*.nbi
21+
*.nbc
22+
/.pytest_cache/
23+
/.dbeaver/
24+
pylint_report.txt

‎.vscode/launch.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Python: Module",
9+
"type": "python",
10+
"request": "launch",
11+
"module": "pymandel"
12+
}
13+
]
14+
}

‎.vscode/settings.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"python.testing.pytestEnabled": true,
3+
"python.testing.unittestEnabled": false,
4+
"python.formatting.provider": "black",
5+
"python.defaultInterpreterPath": "python3",
6+
"editor.formatOnSave": true,
7+
"modulename": "pymandel",
8+
"distname": "pymandel",
9+
"moduleversion": "1.0.13"
10+
}

‎.vscode/tasks.json‎

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=733558
3+
// for the documentation about the tasks.json format
4+
// Use the Install Build/Test Dependencies tasks to install the necessary toolchain.
5+
"version": "2.0.0",
6+
"tasks": [
7+
{
8+
"label": "Install Dependencies",
9+
"type": "process",
10+
"command": "${config:python.defaultInterpreterPath}",
11+
"args": [
12+
"-m",
13+
"pip",
14+
"install",
15+
"--upgrade",
16+
"."
17+
],
18+
"problemMatcher": []
19+
},
20+
{
21+
"label": "Clean",
22+
"type": "shell",
23+
"command": "rm",
24+
"args": [
25+
"-rfvd",
26+
"build",
27+
"dist",
28+
"htmlcov",
29+
"docs/_build",
30+
"${config:modulename}.egg-info",
31+
],
32+
"windows": {
33+
"command": "Get-ChildItem",
34+
"args": [
35+
"-Path",
36+
"build\\,",
37+
"dist\\,",
38+
"htmlcov\\,",
39+
"docs\\_build,",
40+
"${config:modulename}.egg-info",
41+
"-Recurse",
42+
"|",
43+
"Remove-Item",
44+
"-Recurse",
45+
"-Confirm:$false",
46+
"-Force",
47+
],
48+
},
49+
"options": {
50+
"cwd": "${workspaceFolder}"
51+
},
52+
"problemMatcher": []
53+
},
54+
{
55+
"label": "Sort Imports",
56+
"type": "process",
57+
"command": "${config:python.defaultInterpreterPath}",
58+
"args": [
59+
"-m",
60+
"isort",
61+
"src",
62+
"--jobs",
63+
"-1"
64+
],
65+
"problemMatcher": []
66+
},
67+
{
68+
"label": "Format",
69+
"type": "process",
70+
"command": "${config:python.defaultInterpreterPath}",
71+
"args": [
72+
"-m",
73+
"black",
74+
"src"
75+
],
76+
"problemMatcher": []
77+
},
78+
{
79+
"label": "Pylint",
80+
"type": "process",
81+
"command": "${config:python.defaultInterpreterPath}",
82+
"args": [
83+
"-m",
84+
"pylint",
85+
"src"
86+
],
87+
"problemMatcher": []
88+
},
89+
{
90+
"label": "Security",
91+
"type": "process",
92+
"command": "${config:python.defaultInterpreterPath}",
93+
"args": [
94+
"-m",
95+
"bandit",
96+
"-c",
97+
"pyproject.toml",
98+
"-r",
99+
"."
100+
],
101+
"problemMatcher": []
102+
},
103+
{
104+
"label": "Build",
105+
"type": "process",
106+
"command": "${config:python.defaultInterpreterPath}",
107+
"args": [
108+
"-m",
109+
"build",
110+
".",
111+
"--wheel",
112+
"--sdist",
113+
],
114+
"problemMatcher": []
115+
},
116+
{
117+
"label": "Test",
118+
"type": "process",
119+
"command": "${config:python.defaultInterpreterPath}",
120+
"args": [
121+
"-m",
122+
"pytest",
123+
],
124+
"problemMatcher": []
125+
},
126+
{
127+
"label": "Sphinx",
128+
"type": "process",
129+
"command": "sphinx-apidoc",
130+
"args": [
131+
"--doc-project=${config:modulename}",
132+
"--doc-author=semuadmin",
133+
"--doc-version=${config:moduleversion}",
134+
"--doc-release=${config:moduleversion}",
135+
"--ext-autodoc",
136+
"--ext-viewcode",
137+
"--templatedir=docs",
138+
"-f",
139+
"-o",
140+
"docs",
141+
"src/${config:modulename}"
142+
],
143+
"problemMatcher": []
144+
},
145+
{
146+
"label": "Sphinx HTML",
147+
"type": "process",
148+
"command": "/usr/bin/make",
149+
"windows": {
150+
"command": "${workspaceFolder}/docs/make.bat"
151+
},
152+
"args": [
153+
"html"
154+
],
155+
"options": {
156+
"cwd": "${workspaceFolder}/docs"
157+
},
158+
"dependsOrder": "sequence",
159+
"dependsOn": [
160+
"Sphinx"
161+
],
162+
"problemMatcher": []
163+
},
164+
{
165+
"label": "Sphinx Deploy to S3", // needs AWS credentials
166+
"type": "process",
167+
"command": "aws",
168+
"args": [
169+
"s3",
170+
"cp",
171+
"${workspaceFolder}/docs/_build/html",
172+
"s3://www.semuconsulting.com/${config:modulename}/",
173+
"--recursive"
174+
],
175+
"dependsOrder": "sequence",
176+
"dependsOn": [
177+
"Sphinx HTML"
178+
],
179+
"problemMatcher": []
180+
},
181+
{
182+
"label": "Install Locally",
183+
"type": "process",
184+
"command": "${config:python.defaultInterpreterPath}",
185+
"args": [
186+
"-m",
187+
"pip",
188+
"install",
189+
"${workspaceFolder}/dist/${config:distname}-${config:moduleversion}-py3-none-any.whl",
190+
"--user",
191+
"--force-reinstall"
192+
],
193+
"dependsOrder": "sequence",
194+
"dependsOn": [
195+
"Clean",
196+
"Install Dependencies",
197+
"Security",
198+
"Sort Imports",
199+
"Format",
200+
"Pylint",
201+
"Test",
202+
"Build",
203+
"Sphinx HTML"
204+
],
205+
"problemMatcher": []
206+
},
207+
]
208+
}

0 commit comments

Comments
 (0)