Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
d2f908d
Add initial 3amigos-py cookiecutter template settings
timgates42 Jul 16, 2019
4e17989
Add initial 3amigos-py template changes.
timgates42 Jul 17, 2019
0c97cef
Template fixes
timgates42 Jul 17, 2019
e7d264e
Apply template fixes
timgates42 Jul 17, 2019
ac45545
Fix Pypi License Tag
timgates42 Jul 17, 2019
e9a9d1f
Running flake8 uncovered a number of bugs - undefined variables etc
timgates42 Jul 17, 2019
95839c0
Fix up line endings
timgates42 Jul 17, 2019
49a2810
Run isort on the module to fix import order
timgates42 Jul 17, 2019
f5c2931
Running bandit uncovered use of SSL verify being hard-coded to False …
timgates42 Jul 17, 2019
9a4525b
Resolve all pylint warnings - found a number of bugs
timgates42 Jul 17, 2019
2f3c8ed
Resolve all pylint cautions
timgates42 Jul 17, 2019
008f1b4
Fix up markdown escaping
timgates42 Jul 17, 2019
7eae00c
Fix spelling seperate -> separate
timgates42 Jul 17, 2019
4dd250f
Add towncrier news article.
timgates42 Jul 17, 2019
be1c934
Provide an initialize method so the super constructer can be called
timgates42 Jul 17, 2019
961e31c
Add package requirements
timgates42 Jul 17, 2019
cb9a697
If an unhandled status code is observed raise an error
timgates42 Jul 17, 2019
fcff6ed
Drop coverage requirement for now
timgates42 Jul 17, 2019
a6e9211
Fix up import order
timgates42 Jul 17, 2019
b3ced83
Add future compatibility imports
timgates42 Jul 17, 2019
4d5f10b
Add futures
timgates42 Jul 17, 2019
f49fbd0
Set Exit 255 to exit on error
timgates42 Jul 17, 2019
7e94bbf
Fix up pylint refactors
timgates42 Jul 17, 2019
b2e917f
Resolve more refactors.
timgates42 Jul 17, 2019
ba59f55
Merge pull request #1 from timgates42/feature/codeanalysis
timgates42 Jul 17, 2019
4fac782
Use click for basic command line interface
timgates42 Jul 18, 2019
6d79b4c
Fix seperate -> separate and other spelling
timgates42 Jul 18, 2019
0da94df
Remove invalid test
timgates42 Jul 18, 2019
9e904ee
fix import order
timgates42 Jul 18, 2019
3c67e9e
Add dummy test case
timgates42 Jul 18, 2019
d885917
Update template
timgates42 Jul 24, 2019
d074c0b
Update requirements
timgates42 Jul 24, 2019
37cc630
Updates to template
timgates42 Jul 24, 2019
0b37393
Updates from upstream
timgates42 Jul 25, 2019
54128d2
Update non-word list
timgates42 Jul 25, 2019
7b7e5a0
Update word list
timgates42 Jul 25, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Calling the function '...'
2. With arguments'....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
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 any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--
Thank you for your contribution to the prtg repository.
Your code will need to pass the automated checks before merging.
Before submitting this PR, please make sure the follow checks are done if
applicable, also if they are applicable move them out of this comment into the
main PR text body:
- [x] Unit tests added
- [x] Documentations updated with the change
- [x] Towncrier news fragment added
-->
118 changes: 118 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# 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/
*.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/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

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

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# 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/

# Pipenv
.local/

# Pylint
.pylint.d

# Pytest
cov.xml
/test-*.xml

# Vim
*.swp
*.swo
89 changes: 89 additions & 0 deletions .pyspelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
spellchecker: aspell

matrix:
- name: restructedtext
sources:
- ./**/*.rst
hunspell:
d: docs/spelling_wordlist.txt
aspell:
lang: en
dictionary:
wordlists:
- docs/spelling_wordlist.txt
output: build/dictionary/restructured.dic
pipeline:
- resplendent.filters.restructuredtext:
- pyspelling.filters.html:
comments: false
attributes:
- title
- alt
ignores:
- code
- pre
- pyspelling.filters.url:

- name: markdown
sources:
- ./**/*.md
hunspell:
d: docs/spelling_wordlist.txt
aspell:
lang: en
dictionary:
wordlists:
- docs/spelling_wordlist.txt
output: build/dictionary/mkdocs.dic
pipeline:
- pyspelling.filters.markdown:
- pyspelling.filters.html:
comments: false
attributes:
- title
- alt
ignores:
- code
- pre
- pyspelling.filters.url:

- name: python
sources:
- ./**/*.py
hunspell:
d: docs/src/dictionary/hunspell/en_AU
aspell:
lang: en
dictionary:
wordlists:
- docs/spelling_wordlist.txt
output: build/dictionary/python.dic
pipeline:
- pyspelling.filters.python:
group_comments: true
- pyspelling.flow_control.wildcard:
allow:
- py-comment
- pyspelling.filters.context:
context_visible_first: true
delimiters:
# Ignore lint (noqa) and coverage (pragma) as well as shebang (#!)
- open: '^(?: *(?:noqa\b|pragma: no cover)|!)'
close: '$'
# Ignore Python encoding string -*- encoding stuff -*-
- open: '^ *-\*-'
close: '-\*-$'
- pyspelling.filters.context:
context_visible_first: true
escapes: '\\[\\`]'
delimiters:
# Ignore multiline content between fences (fences can have 3 or more back ticks)
# ```
# content
# ```
- open: '(?s)^(?P<open> *`{3,})$'
close: '^(?P=open)$'
# Ignore text between inline back ticks
- open: '(?P<open>`+)'
close: '(?P=open)'
- pyspelling.filters.url:
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at tim.gates@iress.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

## Code of Conduct

Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it
in all your interactions with the project.

## Member Responsibilities

First things first, the prtg-dev community welcomes all contributors with
good intentions and we will as much as possible respect your efforts to
contribute. Specifically we will try and request changes where required and as
last resort make changes on top of pull requests leaving your work with due
acknowledgement. We will specifically avoid finding some fault with your code
and then submit a similar pull request that contains little acknowledgement of
the original work.

## Contributor Responsibilities

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change. Contributing
to this repository is greatly welcomed and the process is to save everyone time to make contributions
efficient rather than be a challenge to overcome.


## Pull Request Process

1. Update the README.md with details of significant changes.
2. You may merge the Pull Request in once you have the sign-off of one other developer, or if you
do not have permission to do that, you may request the reviewer to merge it for you.

Loading