Skip to content

Commit 29750e0

Browse files
authored
Initial commit
0 parents  commit 29750e0

26 files changed

+1078
-0
lines changed

.github/workflows/package.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: conda packaging and deployment
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: [qa, main]
7+
tags: ['v*']
8+
9+
jobs:
10+
linux:
11+
runs-on: ubuntu-latest
12+
defaults:
13+
run:
14+
shell: bash -l {0}
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: conda-incubator/setup-miniconda@v2
18+
with:
19+
auto-update-conda: true
20+
mamba-version: "*"
21+
environment-file: environment.yml
22+
cache-environment-key: ${{ runner.os }}-env-${{ hashFiles('**/environment.yml') }}
23+
cache-downloads-key: ${{ runner.os }}-downloads-${{ hashFiles('**/environment.yml') }}
24+
- name: install additional dependencies
25+
run: |
26+
echo "installing additional dependencies from environment_development.yml"
27+
- name: build conda package
28+
run: |
29+
# set up environment
30+
cd conda.recipe
31+
echo "versioningit $(versioningit ../)"
32+
# build the package
33+
VERSION=$(versioningit ../) conda mambabuild --output-folder . .
34+
conda verify noarch/mypackagename*.tar.bz2
35+
- name: upload conda package to anaconda
36+
shell: bash -l {0}
37+
if: startsWith(github.ref, 'refs/tags/v')
38+
env:
39+
ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_TOKEN }}
40+
IS_RC: ${{ contains(github.ref, 'rc') }}
41+
run: |
42+
# label is main or rc depending on the tag-name
43+
CONDA_LABEL="main"
44+
if [ "${IS_RC}" = "true" ]; then CONDA_LABEL="rc"; fi
45+
echo pushing ${{ github.ref }} with label $CONDA_LABEL
46+
anaconda upload --label $CONDA_LABEL conda.recipe/noarch/mypackagename*.tar.bz2

.github/workflows/unittest.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: unit-test
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
push:
7+
branches: [next, qa, main]
8+
tags: ['v*']
9+
10+
jobs:
11+
linux:
12+
runs-on: ubuntu-latest
13+
defaults:
14+
run:
15+
shell: bash -l {0}
16+
steps:
17+
- uses: actions/checkout@v3
18+
- uses: conda-incubator/setup-miniconda@v2
19+
with:
20+
auto-update-conda: true
21+
mamba-version: "*"
22+
environment-file: environment.yml
23+
cache-environment-key: ${{ runner.os }}-env-${{ hashFiles('**/environment.yml') }}
24+
cache-downloads-key: ${{ runner.os }}-downloads-${{ hashFiles('**/environment.yml') }}
25+
- name: install additional dependencies
26+
run: |
27+
echo "installing additional dependencies if cannot be installed from conda"
28+
- name: run unit tests
29+
run: |
30+
echo "running unit tests"
31+
python -m pytest --cov=src --cov-report=xml --cov-report=term-missing tests/
32+
- name: upload coverage to codecov
33+
uses: codecov/codecov-action@v1

.gitignore

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py,cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# poetry
98+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102+
#poetry.lock
103+
104+
# pdm
105+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106+
#pdm.lock
107+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108+
# in version control.
109+
# https://pdm.fming.dev/#use-with-ide
110+
.pdm.toml
111+
112+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113+
__pypackages__/
114+
115+
# Celery stuff
116+
celerybeat-schedule
117+
celerybeat.pid
118+
119+
# SageMath parsed files
120+
*.sage.py
121+
122+
# Environments
123+
.env
124+
.venv
125+
env/
126+
venv/
127+
ENV/
128+
env.bak/
129+
venv.bak/
130+
131+
# Spyder project settings
132+
.spyderproject
133+
.spyproject
134+
135+
# Rope project settings
136+
.ropeproject
137+
138+
# mkdocs documentation
139+
/site
140+
141+
# mypy
142+
.mypy_cache/
143+
.dmypy.json
144+
dmypy.json
145+
146+
# Pyre type checker
147+
.pyre/
148+
149+
# pytype static type analyzer
150+
.pytype/
151+
152+
# Cython debug symbols
153+
cython_debug/
154+
155+
# PyCharm
156+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158+
# and can be added to the global gitignore or merged into this file. For a more nuclear
159+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160+
#.idea/

.pre-commit-config.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.5.0
4+
hooks:
5+
- id: check-added-large-files
6+
args: [--maxkb=8192]
7+
- id: check-merge-conflict
8+
- id: check-yaml
9+
args: [--allow-multiple-documents]
10+
exclude: "conda.recipe/meta.yaml"
11+
- id: end-of-file-fixer
12+
exclude: "tests/cis_tests/.*"
13+
- id: trailing-whitespace
14+
exclude: "tests/cis_tests/.*"
15+
- repo: https://github.com/astral-sh/ruff-pre-commit
16+
rev: v0.2.2
17+
hooks:
18+
- id: ruff
19+
args: [--fix, --exit-non-zero-on-fix]
20+
exclude: "tests/cis_tests/.*"
21+
- id: ruff-format
22+
exclude: "tests/cis_tests/.*"

.readthedocs.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-20.04
5+
tools:
6+
python: "mambaforge-4.10"
7+
8+
sphinx:
9+
builder: html
10+
configuration: docs/conf.py
11+
fail_on_warning: true
12+
13+
conda:
14+
environment: environment.yml

0 commit comments

Comments
 (0)