Merge pull request #15 from sepandhaghighi/dev

Version 0.3

.coveragerc

@@ -0,0 +1,9 @@
+[run]
+branch = True
+omit =
+    */pyrgg/__main__.py
+    */pyrgg/__init__.py
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    pragma: no cover

.github/CODE_OF_CONDUCT.md

@@ -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 [email protected]. 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

.github/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contribution			
+
+Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request.		
+
+
+Please consider the following :
+
+
+1. Fork it!
+2. Create your feature branch (under `dev` branch)
+3. Add your functions/methods to proper files
+4. Add standard `docstring` to your functions/methods
+5. Add tests for your functions/methods (`doctest` testcases in `test` folder)
+6. Pass all CI tests
+7. Update `CHANGELOG.md`
+	- Describe changes under `[Unreleased]` section
+8. Submit a pull request into `dev` (please complete the pull request template)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+#### Description
+
+#### Steps/Code to Reproduce
+
+#### Expected Behavior
+
+#### Actual Behavior
+
+#### Operating System
+
+#### Python Version
+
+#### Pyrgg Version

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+#### Reference Issues/PRs
+
+#### What does this implement/fix? Explain your changes.
+
+
+#### Any other comments?
+

.gitignore

@@ -1,2 +1,110 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Python template
+# Byte-compiled / optimized / DLL files
 node_modules/
 datasets/
+__pycache__/
+*.py[cod]
+*$py.class
+
+*.gr
+*.json
+*.csv
+*.wel
+*.lp
+*.p
+*.dl
+*.tgf
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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
+
+# 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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# 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
+
+# dotenv
+.env
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+### Example user template template
+### Example user template
+
+# IntelliJ project files
+.idea
+*.iml
+out
+gen

.travis.yml

@@ -1,15 +1,39 @@
-sudo: true
-
 language: python
 
-python:
-  - 3.5
-
+matrix:
+    include:
+        - os: linux
+          python: 3.7
+          dist: xenial
+        - os: linux
+          python: 3.6
+        - os: linux
+          python: 3.5
+        - os: linux
+          python: 3.4
+        - os: linux
+          python: 2.7
+        - os: osx
+          language: generic
+          env: TOXENV=py36
+        - os: linux
+          python: 3.7-dev
+          dist: xenial
+        - os: linux
+          python: 3.8-dev
+          dist: xenial
+        - os: linux
+          python: nightly
+          dist: xenial
+    allow_failures:
+        - os: linux
+          python: 2.7
 install:
-  - pip3 install -r requirements.txt
-  - python3 setup.py install
-
+  - chmod +x .travis/install.sh
+  - .travis/install.sh
+before_script:
+  - chmod +x .travis/test.sh
 script:
-  - python3 -m pyrgg test
+  - .travis/test.sh
 after_success:
   - codecov

.travis/install.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+# Dump Environment (so that we can check PATH, UT_FLAGS, etc.)
+ set -e
+ set -x
+ PYTHON_COMMAND=python
+ PIP_COMMAND=pip
+ if [ "$TRAVIS_OS_NAME" == "osx" ]
+ then
+	 PYTHON_COMMAND=python3
+	 PIP_COMMAND=pip3
+ fi
+
+ $PIP_COMMAND install -r requirements.txt
+ $PYTHON_COMMAND setup.py install
+ $PYTHON_COMMAND -m pyrgg test
+
+ if [ "$TRAVIS_OS_NAME" == "osx" ]
+ then
+	$PIP_COMMAND install --upgrade --upgrade-strategy=only-if-needed -r dev-requirements.txt --user
+  else
+	$PIP_COMMAND install --upgrade --upgrade-strategy=only-if-needed -r dev-requirements.txt
+ fi

.travis/test.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+# Dump Environment (so that we can check PATH, UT_FLAGS, etc.)
+ set -e
+ set -x
+ IS_IN_TRAVIS=false
+ PYTHON_COMMAND=python
+
+ if [ "$TRAVIS_OS_NAME" == "osx" ]
+ then
+	PYTHON_COMMAND=python3
+ fi
+
+ if [ "$CI" = 'true' ] && [ "$TRAVIS" = 'true' ]
+ then
+      IS_IN_TRAVIS=true
+ fi
+ $PYTHON_COMMAND -m pytest test --cov=pyrgg --cov-report=term
+ if [ "$IS_IN_TRAVIS" = 'false' ] || [ "$TRAVIS_PYTHON_VERSION" = '3.6' ]
+ then
+     $PYTHON_COMMAND -m vulture pyrgg setup.py otherfile --min-confidence 65 --sort-by-size
+	 $PYTHON_COMMAND -m bandit -r pyrgg -s B311,B403,B322
+	 $PYTHON_COMMAND otherfile/version_check.py
+	 $PYTHON_COMMAND -m pydocstyle --match-dir=pyrgg
+ fi
+ $PYTHON_COMMAND -m cProfile -s cumtime otherfile/pyrgg_profile.py
+
+

AUTHORS.md

@@ -1,4 +1,4 @@
 # Core Developers #
 
 ----------
-- Sepand Haghighi - Sharif University Of Technology/Moduland Co - ([http://github.com/sepandhaghighi](http://github.com/sepandhaghighi)) ([[email protected]](mailto:[email protected]))
+- Sepand Haghighi - Sharif University Of Technology - ([@sepandhaghighi](http://github.com/sepandhaghighi)) ([[email protected]](mailto:[email protected]))