Skip to content

Commit ab6ab22

Browse files
authored
v0.1.0
2 parents 8dff5f0 + 512bf41 commit ab6ab22

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

+2708
-1
lines changed

.btd.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
input: doc
2+
output: _build
3+
requirements: requirements.txt
4+
target: gh-pages
5+
formats: [ html, pdf, man ]
6+
images:
7+
base: btdi/sphinx:pytooling
8+
latex: btdi/latex
9+
theme: https://codeload.GitHub.com/buildthedocs/sphinx.theme/tar.gz/v1

.editorconfig

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
# end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_style = tab
9+
indent_size = 2
10+
tab_width = 2
11+
12+
13+
[*.py]
14+
indent_style = tab
15+
indent_size = 2
16+
17+
[*.{yml,yaml}]
18+
indent_style = space
19+
indent_size = 2
20+
21+
[*.{json,ini}]
22+
indent_style = tab
23+
indent_size = 2
24+
25+
[*.md]
26+
trim_trailing_whitespace = false
27+
28+
[*.rst]
29+
indent_style = space
30+
indent_size = 3

.github/dependabot.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
version: 2
2+
updates:
3+
# Maintain Python packages
4+
- package-ecosystem: "pip"
5+
directory: "/"
6+
target-branch: dev
7+
commit-message:
8+
prefix: "[Dependabot]"
9+
labels:
10+
- Dependencies
11+
reviewers:
12+
- Paebbels
13+
- Umarcor
14+
schedule:
15+
interval: "daily" # Checks on Monday trough Friday.
16+
17+
# Maintain GitHub Action runners
18+
- package-ecosystem: "github-actions"
19+
directory: "/"
20+
target-branch: dev
21+
commit-message:
22+
prefix: "[Dependabot]"
23+
labels:
24+
- Dependencies
25+
reviewers:
26+
- Paebbels
27+
- Umarcor
28+
schedule:
29+
interval: "weekly"

.github/pull_request_template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# New Features
2+
3+
* tbd
4+
5+
# Changes
6+
7+
* tbd
8+
9+
# Bug Fixes
10+
11+
* tbd
12+
13+
----------
14+
# Related PRs:
15+
16+
* tbd

.github/workflows/Pipeline.yml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
name: Pipeline
2+
3+
on:
4+
push:
5+
workflow_dispatch:
6+
schedule:
7+
- cron: '0 0 * * 5'
8+
9+
jobs:
10+
11+
Params:
12+
uses: pyTooling/Actions/.github/workflows/Parameters.yml@dev
13+
with:
14+
name: pySystemRDLModel
15+
16+
UnitTesting:
17+
uses: pyTooling/Actions/.github/workflows/UnitTesting.yml@dev
18+
needs:
19+
- Params
20+
with:
21+
jobs: ${{ needs.Params.outputs.python_jobs }}
22+
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}
23+
24+
Coverage:
25+
uses: pyTooling/Actions/.github/workflows/CoverageCollection.yml@dev
26+
needs:
27+
- Params
28+
with:
29+
python_version: ${{ needs.Params.outputs.python_version }}
30+
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
31+
secrets:
32+
codacy_token: ${{ secrets.CODACY_PROJECT_TOKEN }}
33+
34+
StaticTypeCheck:
35+
uses: pyTooling/Actions/.github/workflows/StaticTypeCheck.yml@dev
36+
needs:
37+
- Params
38+
with:
39+
python_version: ${{ needs.Params.outputs.python_version }}
40+
commands: |
41+
mypy --html-report htmlmypy -p pySystemRDLModel
42+
html_artifact: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
43+
44+
PublishTestResults:
45+
uses: pyTooling/Actions/.github/workflows/PublishTestResults.yml@dev
46+
needs:
47+
- UnitTesting
48+
49+
Package:
50+
uses: pyTooling/Actions/.github/workflows/Package.yml@dev
51+
needs:
52+
- Params
53+
- Coverage
54+
with:
55+
python_version: ${{ needs.Params.outputs.python_version }}
56+
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
57+
58+
Release:
59+
uses: pyTooling/Actions/.github/workflows/Release.yml@dev
60+
if: startsWith(github.ref, 'refs/tags')
61+
needs:
62+
- UnitTesting
63+
- Coverage
64+
- StaticTypeCheck
65+
- Package
66+
67+
PublishOnPyPI:
68+
uses: pyTooling/Actions/.github/workflows/PublishOnPyPI.yml@dev
69+
if: startsWith(github.ref, 'refs/tags')
70+
needs:
71+
- Params
72+
- Release
73+
- Package
74+
with:
75+
python_version: ${{ needs.Params.outputs.python_version }}
76+
requirements: -r dist/requirements.txt
77+
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
78+
secrets:
79+
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
80+
81+
# VerifyDocs:
82+
# uses: pyTooling/Actions/.github/workflows/VerifyDocs.yml@dev
83+
# needs:
84+
# - Params
85+
# with:
86+
# python_version: ${{ needs.Params.outputs.python_version }}
87+
88+
BuildTheDocs:
89+
uses: pyTooling/Actions/.github/workflows/BuildTheDocs.yml@dev
90+
needs:
91+
- Params
92+
# - VerifyDocs
93+
with:
94+
artifact: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
95+
96+
PublishToGitHubPages:
97+
uses: pyTooling/Actions/.github/workflows/PublishToGitHubPages.yml@dev
98+
needs:
99+
- Params
100+
- BuildTheDocs
101+
- Coverage
102+
- StaticTypeCheck
103+
with:
104+
doc: ${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}
105+
coverage: ${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
106+
typing: ${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
107+
108+
ArtifactCleanUp:
109+
uses: pyTooling/Actions/.github/workflows/ArtifactCleanUp.yml@dev
110+
needs:
111+
- Params
112+
- UnitTesting
113+
- Coverage
114+
- StaticTypeCheck
115+
- BuildTheDocs
116+
- PublishToGitHubPages
117+
- PublishTestResults
118+
with:
119+
package: ${{ fromJson(needs.Params.outputs.artifact_names).package_all }}
120+
remaining: |
121+
${{ fromJson(needs.Params.outputs.artifact_names).unittesting_xml }}-*
122+
${{ fromJson(needs.Params.outputs.artifact_names).codecoverage_html }}
123+
${{ fromJson(needs.Params.outputs.artifact_names).statictyping_html }}
124+
${{ fromJson(needs.Params.outputs.artifact_names).documentation_html }}

.gitignore

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Python cache and object files
2+
__pycache__/
3+
*.py[cod]
4+
5+
# Coverage.py
6+
.coverage
7+
.cov
8+
coverage.xml
9+
10+
# setuptools
11+
/build/
12+
/dist/
13+
/*.egg-info
14+
15+
# Dependencies
16+
!requirements.txt
17+
18+
# Sphinx
19+
/doc/_build/
20+
/doc/_theme/
21+
/doc/pySystemRDLModel/**/*.*
22+
!/doc/pySystemRDLModel/index.rst
23+
24+
# PyCharm project files
25+
/.idea/workspace.xml

.idea/inspectionProfiles/profiles_settings.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/modules.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/pySystemRDLModel.iml

Lines changed: 14 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/vcs.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)