Skip to content

Commit 2648d66

Browse files
sarahmishsarahmish
committed
initial commit
1 parent 269036e commit 2648d66

29 files changed

+1424
-67
lines changed

‎.editorconfig

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.py]
14+
max_line_length = 99
15+
16+
[*.bat]
17+
indent_style = tab
18+
end_of_line = crlf
19+
20+
[LICENSE]
21+
insert_final_newline = false
22+
23+
[Makefile]
24+
indent_style = tab

‎.github/ISSUE_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* sigllm version:
2+
* Python version:
3+
* Operating System:
4+
5+
### Description
6+
7+
Describe what you were trying to get done.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### What I Did
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

‎.github/workflows/docs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Generate Docs
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
7+
jobs:
8+
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- name: Python
15+
uses: actions/setup-python@v1
16+
with:
17+
python-version: '3.8'
18+
19+
- name: Build
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install -e .[dev]
23+
make docs
24+
- name: Deploy
25+
uses: peaceiris/actions-gh-pages@v3
26+
with:
27+
github_token: ${{secrets.GITHUB_TOKEN}}
28+
publish_dir: docs/_build/html

‎.github/workflows/tests.yml

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Run Tests
5+
6+
on:
7+
push:
8+
branches: [ '*' ]
9+
pull_request:
10+
branches: [ master ]
11+
12+
jobs:
13+
lint:
14+
runs-on: ${{ matrix.os }}
15+
strategy:
16+
matrix:
17+
python-version: [3.8]
18+
os: [ubuntu-latest, macos-latest, windows-latest]
19+
steps:
20+
- uses: actions/checkout@v1
21+
- name: Set up Python ${{ matrix.python-version }}
22+
uses: actions/setup-python@v2
23+
with:
24+
python-version: ${{ matrix.python-version }}
25+
- name: Install package
26+
run: pip install invoke .[dev]
27+
- name: invoke lint
28+
run: invoke lint
29+
30+
31+
docs:
32+
runs-on: ${{ matrix.os }}
33+
strategy:
34+
matrix:
35+
python-version: ['3.8', '3.9', '3.10', '3.11']
36+
os: [ubuntu-20.04]
37+
steps:
38+
- uses: actions/checkout@v1
39+
- name: Set up Python ${{ matrix.python-version }}
40+
uses: actions/setup-python@v2
41+
with:
42+
python-version: ${{ matrix.python-version }}
43+
- name: Install package
44+
run: pip install .[dev]
45+
- name: make docs
46+
run: make docs
47+
48+
49+
readme:
50+
runs-on: ${{ matrix.os }}
51+
strategy:
52+
matrix:
53+
python-version: ['3.8', '3.9', '3.10', '3.11']
54+
os: [ubuntu-20.04, macos-latest]
55+
steps:
56+
- uses: actions/checkout@v1
57+
- name: Set up Python ${{ matrix.python-version }}
58+
uses: actions/setup-python@v2
59+
with:
60+
python-version: ${{ matrix.python-version }}
61+
- name: Install package and dependencies
62+
run: pip install invoke rundoc .
63+
- name: invoke readme
64+
run: invoke readme
65+
66+
67+
unit:
68+
runs-on: ${{ matrix.os }}
69+
strategy:
70+
matrix:
71+
python-version: ['3.8', '3.9', '3.10', '3.11']
72+
os: [ubuntu-20.04, macos-latest, windows-latest]
73+
steps:
74+
- uses: actions/checkout@v1
75+
- name: Set up Python ${{ matrix.python-version }}
76+
uses: actions/setup-python@v2
77+
with:
78+
python-version: ${{ matrix.python-version }}
79+
- name: Install package and dependencies
80+
run: pip install invoke .[test]
81+
- name: invoke unit
82+
run: invoke unit
83+
84+
85+
minimum:
86+
runs-on: ${{ matrix.os }}
87+
strategy:
88+
matrix:
89+
python-version: ['3.8', '3.9', '3.10', '3.11']
90+
os: [ubuntu-20.04, macos-latest]
91+
steps:
92+
- uses: actions/checkout@v1
93+
- name: Set up Python ${{ matrix.python-version }}
94+
uses: actions/setup-python@v2
95+
with:
96+
python-version: ${{ matrix.python-version }}
97+
- name: Install package and dependencies
98+
run: pip install invoke .[test]
99+
- name: invoke minimum
100+
run: invoke minimum
101+
102+
103+
tutorials:
104+
runs-on: ${{ matrix.os }}
105+
strategy:
106+
matrix:
107+
python-version: ['3.8', '3.9', '3.10', '3.11']
108+
os: [ubuntu-20.04, macos-latest, windows-latest]
109+
steps:
110+
- uses: actions/checkout@v1
111+
- name: Set up Python ${{ matrix.python-version }}
112+
uses: actions/setup-python@v2
113+
with:
114+
python-version: ${{ matrix.python-version }}
115+
- name: Install package and dependencies
116+
run: pip install invoke jupyter matplotlib .
117+
- name: invoke tutorials
118+
run: invoke tutorials

‎.gitignore

Lines changed: 10 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ __pycache__/
88

99
# Distribution / packaging
1010
.Python
11+
env/
1112
build/
1213
develop-eggs/
1314
dist/
@@ -20,11 +21,9 @@ parts/
2021
sdist/
2122
var/
2223
wheels/
23-
share/python-wheels/
2424
*.egg-info/
2525
.installed.cfg
2626
*.egg
27-
MANIFEST
2827

2928
# PyInstaller
3029
# Usually these files are written by a python script from a template
@@ -39,17 +38,14 @@ pip-delete-this-directory.txt
3938
# Unit test / coverage reports
4039
htmlcov/
4140
.tox/
42-
.nox/
4341
.coverage
4442
.coverage.*
4543
.cache
4644
nosetests.xml
4745
coverage.xml
4846
*.cover
49-
*.py,cover
5047
.hypothesis/
5148
.pytest_cache/
52-
cover/
5349

5450
# Translations
5551
*.mo
@@ -58,8 +54,6 @@ cover/
5854
# Django stuff:
5955
*.log
6056
local_settings.py
61-
db.sqlite3
62-
db.sqlite3-journal
6357

6458
# Flask stuff:
6559
instance/
@@ -70,63 +64,30 @@ instance/
7064

7165
# Sphinx documentation
7266
docs/_build/
67+
docs/api/
7368

7469
# PyBuilder
75-
.pybuilder/
7670
target/
7771

7872
# Jupyter Notebook
7973
.ipynb_checkpoints
8074

81-
# IPython
82-
profile_default/
83-
ipython_config.py
84-
8575
# 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
76+
.python-version
77+
78+
# celery beat schedule file
11679
celerybeat-schedule
117-
celerybeat.pid
11880

11981
# SageMath parsed files
12082
*.sage.py
12183

122-
# Environments
84+
# dotenv
12385
.env
86+
87+
# virtualenv
12488
.venv
125-
env/
12689
venv/
12790
ENV/
128-
env.bak/
129-
venv.bak/
13091

13192
# Spyder project settings
13293
.spyderproject
@@ -140,21 +101,6 @@ venv.bak/
140101

141102
# mypy
142103
.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/
154104

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/
105+
# Vim
106+
.*.swp

‎AUTHORS.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Sarah Alnegheimish <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

0 commit comments

Comments
 (0)