Merge branch 'clean-repo'

.circleci/config.yml

@@ -0,0 +1,61 @@
+# Python CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-python/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/python:3.6.1
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "requirements.txt" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            python3 -m venv venv
+            . venv/bin/activate
+            pip install -r requirements.txt -r requirements_dev.txt
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "requirements.txt" }}
+
+      - run:
+          name: run linter
+          command: |
+            . venv/bin/activate
+            make lint
+
+      - run:
+          name: check code format
+          command: |
+            . venv/bin/activate
+            make check-formatting
+
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+            make test
+
+      - store_artifacts:
+          path: test-reports
+          destination: test-reports
+
+      - run:
+          name: upload coverage report
+          command: |
+            . venv/bin/activate
+            codecov -t=$CODECOV_TOKEN

.flake8

@@ -0,0 +1,12 @@
+[flake8]
+ignore =
+    D203,
+    E501
+exclude =
+    .git,
+    __pycache__,
+    docs/source/conf.py,
+    old,
+    build,
+    dist
+max-complexity = 10

.gitignore

@@ -1,39 +1,126 @@
-# test file
-test.py
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
 
-# Packages
+# 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
-*.eggs
-*.egg-info
-*.cache
+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
-.tox
-nosetests.xml
+.coverage.*
 .cache
-eggs
-
-# pycache
-__pychache__
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
 .pytest_cache/
-*.pyc
-
-# docs
-docs/_build
-docs/_static
-docs/_templates
-docs/reference/generated
-docs/reference/classes/generated
-docs/reference/functions/generated
-docs/reference/invariants/generated
-
-# dist and build
-/dist
-/build
-
-# scratch folder
-/scratch
-
-# virtual environments
-/venv
+
+# 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
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.vscode

Makefile

@@ -0,0 +1,11 @@
+lint:
+	flake8 grinpy/
+
+check-formatting:
+	black --check grinpy/
+
+format:
+	black grinpy/
+
+test:
+	pytest -vv --cov=grinpy/ .

README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/somacdivad/grinpy.svg?branch=master)](https://travis-ci.org/somacdivad/grinpy) [![Build status](https://ci.appveyor.com/api/projects/status/aqqnfhlce26f09xn/branch/master?svg=true)](https://ci.appveyor.com/project/somacdivad/grinpy/branch/master) [![BCH compliance](https://bettercodehub.com/edge/badge/somacdivad/grinpy)](https://bettercodehub.com/) [![codecov](https://codecov.io/gh/somacdivad/grinpy/branch/master/graph/badge.svg)](https://codecov.io/gh/somacdivad/grinpy) [![Documentation Status](https://readthedocs.org/projects/grinpy/badge/)](http://grinpy.readthedocs.io/en/latest/)
+[![CircleCI](https://circleci.com/gh/somacdivad/grinpy.svg?style=svg)](https://circleci.com/gh/somacdivad/grinpy) [![Documentation Status](https://readthedocs.org/projects/grinpy/badge/)](http://grinpy.readthedocs.io/en/latest/) [![BCH compliance](https://bettercodehub.com/edge/badge/somacdivad/grinpy)](https://bettercodehub.com/) [![codecov](https://codecov.io/gh/somacdivad/grinpy/branch/master/graph/badge.svg)](https://codecov.io/gh/somacdivad/grinpy)  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) [![PyPI version](https://badge.fury.io/py/grinpy.svg)](https://badge.fury.io/py/grinpy)
 
 # GrinPy
 *A NetworkX extension for calculating graph invariants.*

docs/reference/classes/generated/grinpy.HavelHakimi.__init__.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.\_\_init\_\_
+===============================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.__init__

docs/reference/classes/generated/grinpy.HavelHakimi.depth.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.depth
+========================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.depth

docs/reference/classes/generated/grinpy.HavelHakimi.get_elimination_sequence.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.get\_elimination\_sequence
+=============================================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.get_elimination_sequence

docs/reference/classes/generated/grinpy.HavelHakimi.get_initial_sequence.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.get\_initial\_sequence
+=========================================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.get_initial_sequence

docs/reference/classes/generated/grinpy.HavelHakimi.get_process.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.get\_process
+===============================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.get_process

docs/reference/classes/generated/grinpy.HavelHakimi.is_graphic.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.is\_graphic
+==============================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.is_graphic

docs/reference/classes/generated/grinpy.HavelHakimi.residue.rst

@@ -0,0 +1,6 @@
+grinpy.HavelHakimi.residue
+==========================
+
+.. currentmodule:: grinpy
+
+.. automethod:: HavelHakimi.residue

docs/reference/functions/generated/grinpy.functions.degree.average_degree.rst

@@ -0,0 +1,6 @@
+grinpy.functions.degree.average\_degree
+=======================================
+
+.. currentmodule:: grinpy.functions.degree
+
+.. autofunction:: average_degree

docs/reference/functions/generated/grinpy.functions.degree.closed_neighborhood_degree_list.rst

@@ -0,0 +1,6 @@
+grinpy.functions.degree.closed\_neighborhood\_degree\_list
+==========================================================
+
+.. currentmodule:: grinpy.functions.degree
+
+.. autofunction:: closed_neighborhood_degree_list