Merge pull request #54 from a-r-j/packaging

[WIP] Packaging

.gitattributes

@@ -0,0 +1 @@
+graphein/_version.py export-subst

.github/workflows/code-tests.yaml

@@ -15,6 +15,7 @@ jobs:
       - name: Setup anaconda
         uses: s-weigand/setup-conda@v1
         with:
+          python-version: 3.8
           conda-channels: "conda-forge"
 
       # # Build cache of environment
@@ -43,6 +44,11 @@ jobs:
           source activate graphein-dev
           pytest .
 
+      - name: Run example notebooks
+        run: |
+          source activate graphein-dev
+          grep -l smoke_test notebooks/*.ipynb | pytest --nbval-lax --current-env
+
       - name: Upload code coverage
         run: |
           bash <(curl -s https://codecov.io/bash)

.readthedocs.yml

@@ -6,7 +6,7 @@
 version: 2
 
 conda:
-  environment: ubuntu_environment.yml
+  environment: environment-dev.yml
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -22,8 +22,7 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: 3.8
   install:
-    - requirements: ./.rtd.requirements.txt
     - method: setuptools
       path: .

.travis.yml

@@ -0,0 +1,29 @@
+language: python
+python:
+  - 3.8
+os:
+  - linux
+  - osx
+install:
+  # ----- Install and set up Miniconda -----
+  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no
+  - conda update -q conda
+  # Useful for debugging any issues with conda
+  - conda info -a
+  # Create the conda environment
+  - conda env create -f environment-dev.yml
+  - source activate graphein-dev
+  - pip install pytest
+
+  # ----- Install Graphein -----
+  - python setup.py install
+script:
+  # Your test script goes here
+  - pytest -vvv tests/
+after_success:
+  - conda install codecov
+  - codecov

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 make 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 within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+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 arian@jamasb.io. 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

CONTRIBUTORS.md

@@ -0,0 +1,19 @@
+# Contributing to Graphein
+Contribution is always welcomed. A good starting place is the roadmap issue, where you can find our current milestones. All contributions must go through pull requests and be reviewed by the committers. See our contribution guide for more details.
+
+Once your contribution is accepted and merged, congratulations, you are now a contributor to the Graphein project. We will put your name in the list below.
+
+##Contributors
+Arian Jamasb: [@a-r-j](https://github.com/a-r-j)
+
+Eric J. Ma: [@ericmjl](https://github.com/ericmjl) 
+
+Ramon Vinas: [@rvinas](https://github.com/rvinas)
+
+Charlie Harris: [cch1999](https://github.com/cch1999)
+
+Dominic Hall: [@dhall1995](https://github.com/dhall1995)
+
+Kexin Huang: [@kexinhuang12345](https://github.com/kexinhuang12345)
+
+Sean Aubi: [@Seanny123](https://github.com/Seanny123)

MANIFEST.in

@@ -1 +1,3 @@
-recursive-include graphein/ *
+recursive-include graphein/ *include versioneer.py
+include graphein/_version.py
+include versioneer.py

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+#### Reference Issues/PRs
+<!--
+Example: Fixes #1234. See also #3456.
+Please use keywords (e.g., Fixes) to create link to the issues or pull requests
+you resolved, so that they will automatically be closed when your pull request
+is merged. See https://github.com/blog/1506-closing-issues-via-pull-requests
+-->
+
+
+#### What does this implement/fix? Explain your changes.
+
+
+#### What testing did you do to verify the changes in this PR?
+
+
+<!--
+We value all user contributions, no matter how minor they are. 
+
+Thanks for contributing!
+-->