Merge pull request #7 from fluffykoalas/dev

Merge 1st release into master

.azure-pipelines/azure-pipelines.yml

@@ -0,0 +1,59 @@
+# Python package
+# Create and test a Python package on multiple Python versions.
+# Add steps that analyze code, save the dist with the build record, publish to a PyPI-compatible index, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/python
+
+trigger:
+- dev
+- master
+
+pr:
+- dev
+- master
+
+
+jobs: 
+- job: "StyleCheck"
+  displayName: "Code Style Check (flake8)"
+  pool:
+    vmImage: "ubuntu-18.04"
+
+  steps:  
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '3.7'
+      addToPath: true
+      architecture: 'x64'
+
+  - script: pip install flake8
+    displayName: "Install flake8"
+
+  - script: flake8 sloth
+    displayName: "Run style check"
+
+- job: "RunTests"
+  pool:
+    vmImage: "ubuntu-18.04"
+  strategy:
+    matrix:
+      Python35:
+        pythonVersion: 3.5
+      Python36:
+        pythonVersion: 3.6
+      Python37:
+        pythonVersion: 3.7
+      Python38:
+        pythonVersion: 3.8
+  steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '$(pythonVersion)'
+      addToPath: true
+      architecture: 'x64'
+  - script: pip install -r tests/test-requirements.txt -r requirements.txt
+    displayName: "Install requirements"
+  - script: pytest --maxfail=3 tests --cov=sloth
+    displayName: "Run the tests"
+  - script: pip install codecov && codecov -e $(pythonVersion) -t $(CODE_COV_TOKEN)
+    displayName: "Upload coverage to CodeCov"
+    condition: succeeded()

.azure-pipelines/release-generator-and-uploader.yml

@@ -0,0 +1,28 @@
+# Python package
+# Create and test a Python package on multiple Python versions.
+# Add steps that analyze code, save the dist with the build record, publish to a PyPI-compatible index, and more:
+# https://docs.microsoft.com/azure/devops/pipelines/languages/python
+
+trigger: none
+pr: none
+
+pool:
+  vmImage: 'ubuntu-latest'
+
+steps:
+- task: UsePythonVersion@0
+  inputs:
+    versionSpec: 3.7
+  displayName: 'Use python 3.7'
+
+- script: pip install twine wheel
+  displayName: 'Install dependencies'
+
+- script: python setup.py sdist bdist_wheel
+  displayName: 'Build package'
+
+- script: twine check dist/*
+  displayName: 'Check packages'
+
+- script: twine upload dist/* --disable-progress-bar -u __token__ -p $(twineToken) --non-interactive
+  displayName: 'Upload package to PyPI'

.coveragerc

@@ -0,0 +1,34 @@
+# ----------------------------------------------------------------------------
+# Copyright (c) 2020 Legorooj <legorooj@protonmail.com>
+# Copyright (c) 2020 FluffyKoalas <github.com/fluffykoalas>
+# This file and all others in this project are licensed under the MIT license.
+# Please see the LICENSE file in the root of this repository for more details.
+# ----------------------------------------------------------------------------
+
+[run]
+branch = True
+cover_pylib = False
+source =
+    sloth
+omit =
+    tests
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    if self\.debug
+    raise AssertionError
+    raise NotImplementedError
+    if 0:
+    if __name__ == .__main__.:
+    raise TypeError
+    pass
+    @abc.abstractmethod
+    def _type_str
+
+ignore_errors = True
+
+[html]
+directory = htmlcov

.flake8

@@ -0,0 +1,13 @@
+[flake8]
+extend-ignore =
+    # Blank line contains whitespace
+    W293
+exclude =
+    .git
+    docs
+    .pytest_cache
+    .github
+    .htmlcov
+    tests
+    __pycache__
+max-line-length = 120

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Think you've found a bug?
+title: ''
+labels: bug, state:verify
+assignees: ''
+
+---
+
+<!-- NO IMAGES - ONLY TEXT -->
+
+### **Describe the bug**
+A clear and concise description of what the bug is.
+
+### **To Reproduce**
+Steps to reproduce the behavior:
+1. Import `x`
+2. Call `x(params)`
+3. See error
+
+### **Expected behavior**
+A clear and concise description of what you expected to happen.
+
+### **Platform (please complete the following information):**
+ - OS: [e.g. Windows]
+ - Version [e.g. 0.5]
+ - Are you using CPython? Conda? PyPy?
+
+### **Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+### **Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+### **Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+### **Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+### **Additional context**
+Add anything else here - as long as they aren't images.

.gitignore

@@ -0,0 +1,135 @@
+# 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/
+
+# PyCharm settings
+.idea/
+
+# Local Testing folder to play with the API
+localtesting/

CHANGELOG.rst

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+The changelog will be added in version 0.2

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Legorooj <legorooj@protonmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.