Merge pull request #76 from OpenBCI/1.0.0

1.0.0

Author: AJ Keller

.codeclimate.yml

@@ -0,0 +1,8 @@
+languages:
+  Python: true
+exclude_paths:
+- "externals/*"
+- "images/*"
+- "plugins/*"
+- "scripts/*"
+- "tests/*"

.coveragerc

@@ -0,0 +1,15 @@
+[report]
+include = */openbci/*
+omit =
+    */python?.?/*
+    */site-packages/nose/*
+    */plugin_interface.py
+    */test_log.py
+    */setup.py
+    */users.py
+    */bluepy/*
+    */externals/*
+    */images/*
+    */plugins/*
+    */scripts/*
+    */tests/*

.gitignore

@@ -67,3 +67,5 @@ target/
 .idea/*
 .idea/codeStyleSettings.xml
 .idea/vcs.xml
+
+.DS_Store

.travis.yml

@@ -0,0 +1,42 @@
+language: python
+env:
+    - PYTHON=2.7
+    - PYTHON=3.4
+# command to install dependencies\
+cache: pip
+sudo: false
+virtualenv:
+  system_site_packages: true
+addons:
+  apt:
+    packages:
+      - libatlas-dev
+      - libatlas3gf-base
+      - libblas-dev
+      - liblapack-dev
+      - python-matplotlib
+      - gfortran
+      - python-tk
+install:
+  - conda create -n testenv --yes pip python=$PYTHON
+  - source activate testenv
+  - conda install --yes --quiet numpy pyserial mock nose coverage
+  - pip install codecov xmltodict bluepy
+  - python setup.py build install
+
+# Setup anaconda
+before_install:
+  - wget -q http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
+  - chmod +x miniconda.sh
+  - ./miniconda.sh -b -p /home/travis/miniconda
+  - export PATH=/home/travis/miniconda/bin:$PATH
+  - conda update --yes --quiet conda
+  # We need to create a (fake) display on Travis (allows Mayavi tests to run)
+  - export DISPLAY=:99.0
+  - /sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -screen 0 1400x900x24 -ac +extension GLX +render -noreset
+
+
+# command to run tests
+script: nosetests  --with-coverage --cover-package=openbci
+after_success:
+  - codecov

CHANGELOG.md

@@ -1,3 +1,30 @@
+# v1.0.0
+
+### New Features
+
+* High speed mode for WiFi shield sends raw data - #51
+* Unit testing with Nosetests
+* Continuous Integration with Travis.ci
+
+### Breaking Changes
+
+* Refactored library for pip
+* Moved plugins folder into openbci dir so plugins can be imported when installed with pip
+
+
+## Beta 0
+
+* Adds high speed for Daisy over WiFi - now all boards are supported!
+
+## Alpha 1
+
+* Adds high speed for Ganglion over WiFi
+
+## Alpha 0
+
+* Adds high speed for Cyton over WiFi
+
+# v0.1
 
 ## dev
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,69 @@
+# OpenBCI Python Code of Conduct
+
+## Purpose
+
+It is our hope that any one is able to contribute to OpenBCI Python regardless of their background. Thus, we hope to provide a safe, welcoming, and warmly geeky environment for everybody, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
+
+## 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]](mailto:[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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+:tada::clinking_glasses:  First off, thanks for taking the time to contribute! :tada::clinking_glasses:
+
+Contributions are always welcome, no matter how small.
+
+The following is a small set of guidelines for how to contribute to the project
+
+## Where to start
+
+### Code of Conduct
+This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md).
+By participating you are expected to adhere to these expectations. Please report unacceptable behaviour to [[email protected]](mailto:[email protected])
+
+### Contributing on Github
+
+If you're new to Git and want to learn how to fork this repo, make your own additions, and include those additions in the master version of this project, check out this [great tutorial](http://blog.davidecoppola.com/2016/11/howto-contribute-to-open-source-project-on-github/).
+
+### Community
+
+This project is maintained by the [OpenBCI](www.openbci.com) and [NeuroTechX](www.neurotechx.com) community. Join the NeuroTechX Slack to check out our #devices channel, where discussions about OpenBCI takes place.
+
+## How can I contribute?
+
+If there's a feature you'd be interested in building, go ahead and we'll support you as much as we can. When you're finished submit a pull request to the master branch referencing the specific issue you addressed.
+
+If you find a bug, or have a suggestion on how to improve the project, just fill out a [Github issue](../../issues)