Skip to content

Commit

Permalink
Final public release
Browse files Browse the repository at this point in the history
  • Loading branch information
Skybound1 committed Nov 24, 2023
0 parents commit ec3fa8a
Show file tree
Hide file tree
Showing 65 changed files with 4,923 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[flake8]
exclude =
.git,
.pybuild,
.eggs,
__pycache__,
.venv

max_line_length = 88

ignore =
#Don't require docstrings on magic methods.
D105,

#Don't require docstrings for __init__ methods.
D107

#Don't require imperative mood docstrings.
D401,

# Line break occurred before a binary operator
W503,

# Whitespace before ':'
E203,

# Don't error on TODOs
T000,

################################################################################################
################################################################################################
################################################################################################
# TODO - Remove these soon!!!

# Missing Docstring in public module
D100,

# Missing Docstring in public module
D101,

# Missing Docstring in public module
D102,

# Missing docstring in public function
D103,

# Missing docstring in public package
D104,

# Missing docstring in public nested class
D106,

# isort found an import in the wrong position
I001,

# isort expected 1 blank line in imports, found 0
I003,

# isort found an unexpected blank line in imports
I004,

################################################################################################
################################################################################################
################################################################################################
56 changes: 56 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: CI

on:
push:
pull_request:
branches:
- main

jobs:
lint:
runs-on: ubuntu-latest

permissions:
id-token: write
contents: read

strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11"]

steps:
- uses: actions/checkout@v3

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}

- name: Install Poetry Action
uses: snok/install-poetry@v1

- name: Install Dependencies
run: poetry install
if: steps.cache.outputs.cache-hit != 'true'

- name: Cache Poetry virtualenv
uses: actions/cache@v3
id: cache
with:
path: ~/.virtualenvs
key: poetry-${{ hashFiles('**/poetry.lock') }}
restore-keys: |
poetry-${{ hashFiles('**/poetry.lock') }}
- name: Run black
run: poetry run black --check .

- name: Run isort
run: poetry run isort --check --verbose --recursive icekube

- name: Run flake8
run: poetry run flake8 icekube

- name: Run mypy
run: poetry run mypy icekube
161 changes: 161 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
data/

# Created by https://www.toptal.com/developers/gitignore/api/vim,python
# Edit at https://www.toptal.com/developers/gitignore?templates=vim,python

### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

### Vim ###
# Swap
[._]*.s[a-v][a-z]
!*.svg # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist
*~
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~

# End of https://www.toptal.com/developers/gitignore/api/vim,python
10 changes: 10 additions & 0 deletions .isort.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[isort]
atomic = true
balanced_wrapping = true
# vertical hanging indent style wrapping
multi_line_output = 3
include_trailing_comma = true

known_first_party = kapi
default_section = THIRDPARTY
sections = FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
Loading

0 comments on commit ec3fa8a

Please sign in to comment.