Skip to content

Commit

Permalink
Initial commit of project structure.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdlaird committed Aug 1, 2020
1 parent 7b6a142 commit 31fa67f
Show file tree
Hide file tree
Showing 25 changed files with 543 additions and 128 deletions.
21 changes: 21 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[run]
omit =
venv/**
*/tests/**
setup.py

[report]
precision = 2
exclude_lines =
pragma: no cover
def __repr__
if self\.debug
if settings\.DEBUG
raise AssertionError
raise NotImplementedError
if 0:
if __name__ == .__main__.:

[html]
title = hookie Coverage Report
directory = _build/coverage
5 changes: 5 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# These are supported funding model platforms

github: alexdlaird
patreon: alexdlaird
custom: ["https://www.paypal.me/alexdlaird"]
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug Report
about: Found a bug? Help us squash it.
title: ''
labels: bug
assignees: ''

---

**Describe the Bug**
A clear and concise description of what the bug is, including exceptions thrown.

**Steps to Reproduce**
A snippet of the code used to reproduce the behavior.

**Expected Behavior**
A brief description of what you expected to happen.

**Environment**
- OS: [e.g. OS X 10.14.5]
- Python Version: [e.g. 3.7.2]
- `hookie` Version: [e.g. 1.3.4]

**Additional Context**
Add any other context about the problem here.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Feature Request
about: Need something? Let us know.
title: ''
labels: enhancement
assignees: ''

---

**Describe the Feature**
A clear and concise description of the how and why of the feature you'd like to see. If possible, include possible code
snippets of interfaces you'd like to see and how you might interact with them.

**Describe Alternative Solutions/Workarounds**
A clear and concise description of any alternative solutions or features you've considered. If applicable, please
provide snippets of any current workarounds you use.

**Additional Context**
Add any other context or screenshots about the feature request here.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Description**
A clear and concise description of what was changed.

**Issues**
A list of GitHub issues related to this PR.

**Type of Change**
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

**Testing Done**
A clear and concise description of the new tests added to validate the change as well as any manual testing done.

**Checklist**
- [ ] My code follows the PEP 8 style guidelines for Python
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code in particularly hard-to-understand areas
- [ ] If applicable, I have made corresponding changes to the documentation
- [ ] I have added tests that prove my change is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] My changes generate no new warnings
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
updates:
- package-ecosystem: pip
directory: "/"
schedule:
interval: daily
time: '13:00'
open-pull-requests-limit: 10
54 changes: 54 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: "CodeQL"

on:
push:
branches: [master, ]
pull_request:
# The branches below must be a subset of the branches above
branches: [master]
schedule:
- cron: '0 19 * * 4'

jobs:
analyse:
name: Analyse
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2

# If this run was triggered by a pull request event, then checkout
# the head of the pull request instead of the merge commit.
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
# Override language selection by uncommenting this and choosing your languages
# with:
# languages: go, javascript, csharp, python, cpp, java

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
23 changes: 23 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Mark stale issues and pull requests

on:
schedule:
- cron: "0 0 * * *"

jobs:
stale:

runs-on: ubuntu-latest

steps:
- uses: actions/stale@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-issue-message: 'This issue is stale because it has remained open with no further activity on it. Comment with additional context or the issue will be closed automatically. Thank you for your contribution!'
stale-pr-message: 'This PR is stale because it has remained open with no further activity on it. If is is still being actively worked by you, label it as "wip", otherwise it will be closed automatically. Thank you for your contribution!'
stale-issue-label: 'stale'
exempt-issue-labels: 'wip,security'
stale-pr-label: 'stale'
exempt-pr-labels: 'wip,security'
days-before-stale: 7
days-before-close: 7
134 changes: 8 additions & 126 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,129 +1,11 @@
# 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/
.idea/
*.iml
*.pyc
.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/
venv
dist/
MANIFEST
*.egg-info
_build
51 changes: 51 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
os: linux
dist: xenial
language: python
python:
- "2.7"
- "3.5"
- "3.8"
install:
- python -m pip install virtualenv
- python -m virtualenv venv
- make install
script:
- make test
- make local
after_success:
- codecov
before_deploy:
- sudo -H python -m pip install setuptools twine --upgrade
- make validate-release VERSION=$TRAVIS_TAG
deploy:
provider: pypi
username: alexdlaird
on:
tags: true
python: "3.8"
jobs:
include:
- name: "OS X, Python: 3.7"
os: osx
language: shell
osx_image: "xcode11.2"
install:
- python3 -m pip install virtualenv
- python3 -m virtualenv venv
- make install
- name: "Windows, Python: 3.7"
os: windows
language: shell
before_install:
- git clone https://github.com/pyenv-win/pyenv-win.git $HOME/.pyenv
- export PATH="$HOME/.pyenv/pyenv-win/bin:$HOME/.pyenv/pyenv-win/shims:$PATH"
- pyenv install -q 3.7.2
- pyenv global 3.7.2
- pyenv rehash
- pyenv local 3.7.2
- python --version
- export PATH="$HOME/.pyenv/pyenv-win/versions/3.7.2/Scripts:$PATH"
install:
- pip install -r requirements.txt -r requirements-dev.txt
script:
- nosetests -s
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Changelog
All notable changes to this project will be documented in this file.

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/alexdlaird/hookie/compare/1.0.0...HEAD)

## [1.0.0](https://github.com/alexdlaird/hookie/releases/tag/1.0.0) - TBD
- TBD
Loading

0 comments on commit 31fa67f

Please sign in to comment.