Skip to content

Commit 4a8b9d7

Browse files
committed
Initial commit
0 parents  commit 4a8b9d7

File tree

17 files changed

+2186
-0
lines changed

17 files changed

+2186
-0
lines changed

.editorconfig

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Check http://editorconfig.org for more information
2+
# This is the main config file for this project:
3+
root = true
4+
5+
[*]
6+
charset = utf-8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
indent_style = space
10+
indent_size = 2
11+
trim_trailing_whitespace = true
12+
13+
[*.{py, pyi}]
14+
indent_style = space
15+
indent_size = 4
16+
17+
[Makefile]
18+
indent_style = tab
19+
20+
[*.md]
21+
trim_trailing_whitespace = false

.github/dependabot.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: pip
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
time: "02:00"
8+
open-pull-requests-limit: 10
9+
- package-ecosystem: pip
10+
directory: "/docs"
11+
schedule:
12+
interval: daily
13+
time: "02:00"
14+
open-pull-requests-limit: 10
15+
16+
- package-ecosystem: github-actions
17+
directory: "/"
18+
schedule:
19+
interval: daily
20+
time: "02:00"
21+
open-pull-requests-limit: 10

.github/workflows/test.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: test
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
workflow_dispatch:
9+
10+
concurrency:
11+
group: ${{ github.head_ref || github.run_id }}
12+
cancel-in-progress: true
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
strategy:
18+
matrix:
19+
python-version: ['3.7', '3.8', '3.9', '3.10']
20+
21+
steps:
22+
- uses: actions/checkout@v2
23+
- name: Set up Python ${{ matrix.python-version }}
24+
uses: actions/setup-python@v2
25+
with:
26+
python-version: ${{ matrix.python-version }}
27+
28+
- name: Install poetry
29+
run: |
30+
curl -sSL \
31+
"https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py" | python
32+
33+
# Adding `poetry` to `$PATH`:
34+
echo "$HOME/.poetry/bin" >> $GITHUB_PATH
35+
36+
- name: Install dependencies
37+
run: |
38+
poetry config virtualenvs.in-project true
39+
poetry install
40+
41+
- name: Run checks
42+
run: make test
43+
44+
# Upload coverage to codecov: https://codecov.io/
45+
- name: Upload coverage to Codecov
46+
uses: codecov/codecov-action@v2
47+
with:
48+
file: ./coverage.xml

.gitignore

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
#### joe made this: http://goel.io/joe
2+
#### macos ####
3+
# General
4+
*.DS_Store
5+
.AppleDouble
6+
.LSOverride
7+
8+
# Icon must end with two \r
9+
Icon
10+
11+
12+
# Thumbnails
13+
._*
14+
15+
# Files that might appear in the root of a volume
16+
.DocumentRevisions-V100
17+
.fseventsd
18+
.Spotlight-V100
19+
.TemporaryItems
20+
.Trashes
21+
.VolumeIcon.icns
22+
.com.apple.timemachine.donotpresent
23+
24+
# Directories potentially created on remote AFP share
25+
.AppleDB
26+
.AppleDesktop
27+
Network Trash Folder
28+
Temporary Items
29+
.apdisk
30+
#### linux ####
31+
*~
32+
33+
# temporary files which can be created if a process still has a handle open of a deleted file
34+
.fuse_hidden*
35+
36+
# KDE directory preferences
37+
.directory
38+
39+
# Linux trash folder which might appear on any partition or disk
40+
.Trash-*
41+
42+
# .nfs files are created when an open file is removed but is still being accessed
43+
.nfs*
44+
#### windows ####
45+
# Windows thumbnail cache files
46+
Thumbs.db
47+
ehthumbs.db
48+
ehthumbs_vista.db
49+
50+
# Dump file
51+
*.stackdump
52+
53+
# Folder config file
54+
Desktop.ini
55+
56+
# Recycle Bin used on file shares
57+
$RECYCLE.BIN/
58+
59+
# Windows Installer files
60+
*.cab
61+
*.msi
62+
*.msm
63+
*.msp
64+
65+
# Windows shortcuts
66+
*.lnk
67+
#### python ####
68+
# Byte-compiled / optimized / DLL files
69+
__pycache__/
70+
*.py[cod]
71+
*$py.class
72+
73+
# C extensions
74+
*.so
75+
76+
# Distribution / packaging
77+
.Python
78+
build/
79+
develop-eggs/
80+
dist/
81+
downloads/
82+
eggs/
83+
.eggs/
84+
lib/
85+
lib64/
86+
parts/
87+
sdist/
88+
var/
89+
wheels/
90+
*.egg-info/
91+
.installed.cfg
92+
*.egg
93+
94+
# PyInstaller
95+
# Usually these files are written by a python script from a template
96+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
97+
*.manifest
98+
*.spec
99+
100+
# Installer logs
101+
pip-log.txt
102+
pip-delete-this-directory.txt
103+
104+
# Unit test / coverage reports
105+
htmlcov/
106+
.tox/
107+
.coverage
108+
.coverage.*
109+
.cache
110+
nosetests.xml
111+
coverage.xml
112+
*.cover
113+
.hypothesis/
114+
115+
# Translations
116+
*.mo
117+
*.pot
118+
119+
# Django stuff:
120+
*.log
121+
local_settings.py
122+
123+
# Flask stuff:
124+
instance/
125+
.webassets-cache
126+
127+
# Scrapy stuff:
128+
.scrapy
129+
130+
# Sphinx documentation
131+
docs/_build/
132+
133+
# PyBuilder
134+
target/
135+
136+
# Jupyter Notebook
137+
.ipynb_checkpoints
138+
139+
# celery beat schedule file
140+
celerybeat-schedule
141+
142+
# SageMath parsed files
143+
*.sage.py
144+
145+
# Environments
146+
.env
147+
.venv
148+
env/
149+
venv/
150+
ENV/
151+
152+
# Spyder project settings
153+
.spyderproject
154+
.spyproject
155+
156+
# Rope project settings
157+
.ropeproject
158+
159+
# mkdocs documentation
160+
/site
161+
162+
# mypy
163+
.mypy_cache/
164+
165+
#### jetbrains ####
166+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
167+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
168+
169+
# User-specific stuff:
170+
.idea/**/workspace.xml
171+
.idea/**/tasks.xml
172+
.idea/dictionaries
173+
174+
# Sensitive or high-churn files:
175+
.idea/**/dataSources/
176+
.idea/**/dataSources.ids
177+
.idea/**/dataSources.xml
178+
.idea/**/dataSources.local.xml
179+
.idea/**/sqlDataSources.xml
180+
.idea/**/dynamic.xml
181+
.idea/**/uiDesigner.xml
182+
183+
# Gradle:
184+
.idea/**/gradle.xml
185+
.idea/**/libraries
186+
187+
# CMake
188+
cmake-build-debug/
189+
190+
# Mongo Explorer plugin:
191+
.idea/**/mongoSettings.xml
192+
193+
## File-based project format:
194+
*.iws
195+
196+
## Plugin-specific files:
197+
198+
# IntelliJ
199+
/out/
200+
201+
# mpeltonen/sbt-idea plugin
202+
.idea_modules/
203+
204+
# JIRA plugin
205+
atlassian-ide-plugin.xml
206+
207+
# Cursive Clojure plugin
208+
.idea/replstate.xml
209+
210+
# Crashlytics plugin (for Android Studio and IntelliJ)
211+
com_crashlytics_export_strings.xml
212+
crashlytics.properties
213+
crashlytics-build.properties
214+
fabric.properties
215+
216+
# pyenv
217+
.python-version

.readthedocs.yml

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: '3.9'
7+
8+
python:
9+
install:
10+
- requirements: 'docs/requirements.txt'
11+
12+
sphinx:
13+
configuration: 'docs/conf.py'
14+
fail_on_warning: true

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Version history
2+
3+
We follow [Semantic Versions](https://semver.org/).
4+
5+
6+
## Version 0.1.0
7+
8+
- Initial release

0 commit comments

Comments
 (0)