andrewvaughan / uhppote-rfid Goto Github PK

Add the following to provide full git support for a Unity project:

• .gitignore
• .gitattributes
• .github/PULL_REQUEST_TEMPLATE.md
• .github/ISSUE_TEMPLATE.md
• .github/CONTRIBUTING.md
• .github/CODE_OF_CONDUCT.md
• .github/SUPPORT.md

See: https://help.github.com/articles/helping-people-contribute-to-your-project/
See: https://git-scm.com/docs/gitattributes

Currently Special Message - determine what this means and adjust accordingly.

Coverage can't be run currently due to bug with test directory.

Currently Last Index - determine what this means and adjust accordingly.

Create setup.py for the module.

Add function to support the "open_door" function for UHPPOTE boards.

Rename the project to be in-line with the type of RFID system being used (once finalized). This should be a unique name for a pip module.

Update all versioning information and release on pip and github.

Add Installation instructions to README.md

Also upload to pypip as described here:
https://python-packaging.readthedocs.io/en/latest/minimal.html

Currently Packet Serial - determine what this means and adjust accordingly.

Add function to support the "dev_status" function for UHPPOTE boards.

Add a comprehensive USAGE.md file for how to use the library.

Update all versioning information and release on pip and github.

Add Installation instructions to README.md

Also upload to pypip as described here:
https://python-packaging.readthedocs.io/en/latest/minimal.html

Currently No Access - determine what this means and adjust accordingly.

Add a class to support various controller board serial number needs.

The dist: precise entry in the .travis.yml file is meant to get around an issue with TravisCI running Trusty. This should be removed when those problems are solved.

(The following is added, as well, as a fix:)

sudo: required
group: deprecated-2017Q3

Sudo should be "false" and group removed.

Add pycodestyle linting support to run with tests:
https://pycodestyle.readthedocs.io/en/latest/intro.html#installation

Once Numpydoc generation is complete, add information to the .github/SUPPORT.md file to show how to generate it.

To prevent warnings on builds, add this handler to loggers:

logging.getLogger('my_logger').addHandler(logging.NullHandler())

Numpydoc:
https://pypi.python.org/pypi/numpydoc

Also add a way to lint numpy standards.

Check tests against actual responses from the controller.

Add function to support the "search" function for UHPPOTE boards.

Add the following features:

• door_delay
• door_delay_get

Coveralls:
https://github.com/coveralls-clients/coveralls-python

Example:
https://github.com/audreyr/how-to/blob/master/python/use_coverage_with_unittest.rst#set-up-coveralls

Add controls to interact with the UHPPOTE board via socket.

Add the following features:

• get_records
• get_record_index
• set_record_index

Currently Latest Swipe or SwipeRecord - determine what this means and adjust accordingly.

Add the following features:

• get_ripp
• set_ripp

Leave the Makefile, but have it call functions from the setup.py method to fit with Python standards.

unittest:
https://docs.python.org/2/library/unittest.html

coverage.py:
https://github.com/audreyr/how-to/blob/master/python/use_coverage_with_unittest.rst

Add the pydocstyle package to instrument strict documentation standards.

Currently Backup - determine what this means and adjust accordingly.

Update all versioning information and release on pip and github.

Add Installation instructions to README.md

Also upload to pypip as described here:
https://python-packaging.readthedocs.io/en/latest/minimal.html

Add the following features:

• get_auth
• add_auth
• del_auth
• del_auth_all
• get_auth_rec

Make sure to update the setup.py file, too. Include the following:

• Badges for:
  • Current Release Version
  • License
  • Build (Continuous Integration) Status
  • Coverage (Coveralls) Status
• Description of project, including tested hardware
• Installation instructions (simple and developer)
• Usage instructions
• Contribution guidelines
• Release policy
• License details

Add the following features:

• get_ip
• set_ip

Add function to support the "get_time" and "set_time" function for UHPPOTE boards.