Updated docs.

blinkter/__init__.py

@@ -27,6 +27,12 @@
 #import .led as led
 #import .threads as threads
 
+__title__ = 'blinkter'
+__author__ = 'speratus'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (C) 2019 speratus'
+__version__ = '1.0.0-rc1'
+
 from .board import *
 from .pixel import *
 from .led import *

docs/conf.py

@@ -13,6 +13,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
+import re
 # import sys
 sys.path.insert(0, os.path.abspath('..'))
 
@@ -24,7 +25,10 @@
 author = 'Andrew Luchuk'
 
 # The full version, including alpha/beta/rc tags
-release = '0.1.5.6'
+version = ''
+with open('../blinkter/__init__.py', 'r') as f:
+    version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read()).group(1)
+release = version
 
 master_doc = 'index'
 autodoc_mock_imports = ['blinkt']

docs/contact.rst

@@ -0,0 +1,15 @@
+Contact Information
+===================
+Official Discord Server: https://discord.gg/YqRfXwJ
+
+Gitter chat room: https://gitter.im/raspberrypi-blinkter/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link
+
+Email: for privacy reasons, I choose not to list my email address.
+
+Preferred contact method: Discord
+
+Gitter has integrations for Github, Bitbucket, and Gitlab, so you should be able to sign up very easily if you do not
+have a Discord account.
+
+**IMPORTANT:** by contacting joining the Discord or Gitter or contributing to the codebase via Github, you agree to
+abide by the :ref:`community-covenant`.

docs/covenant.rst

@@ -0,0 +1,74 @@
+.. _community-covenant:
+Blinkter Community Covenant
+===========================
+**IMPORTANT:** by joining the Discord or Gitter community or contributing to the codebase via Github, you agree to abide
+by the following rules.
+
+A. Rules
+-----
+
+1. You shall show respect to every member of whichever community you join.
+
+   Showing Respect includes but is not limited to:
+
+   a. You shall not insult any person for any reason.
+   b. You shall not use any kind of derogatory name or label for any member of the community.
+
+
+2. You shall not use sexual language of any kind. This applies in the broadest possible sense: if something you are
+   considering posting *could be* construed as sexual language or a sexual reference, do not post it. Additionally, you
+   shall not post pictures of, videos of, or links to anything that is not safe for work (NSFW).
+
+   Violations of this rule may result in a permanent ban without prior notice or a warning of any kind.
+
+3. Recognize that the ability to communicate with members of the community is granted to you as a privilege and
+   not a right. Do not abuse that privilege. In other words, do not advertise for anything, send spam, or engage in any
+   other activity which is outside the scope of the community.
+
+B. Reporting Violations
+--------------------
+If you find that a member of the community has violated these rules, you may report such a violation by sending a
+direct message to a moderator on either of the above mentioned platforms.
+
+A violation report must include the following:
+
+1. A description of the violation along with the username of the violator.
+2. If possible, a screen shot of the offending message or comment. This will aid me in determining whether a violation
+   has occurred.
+
+C. Enforcement Process
+~~~~~~~~~~~~~~~~~~~
+If a violation is reported a moderator, the moderator will take the following steps:
+
+1. He/she will take all reasonable steps to ascertain the veracity of the report.
+2. He/she will notify the alleged violator that they have been reported for a violation of the rules. The alleged violator
+   is then free to defend their behavior. The moderator will take in to consideration the claims of the alleged violator
+   when assessing the veracity of the violation report.
+3. Except where otherwise noted, if the report is found to be true, and this is a first time violation, the moderator
+   will issue a warning to the violator.
+
+   a. If the violator has received two warnings, the violator may be banned. The alleged violator will be issued no more
+      than three (3) warnings. Upon a fourth violation, the violator will be banned, and although a moderator may inform
+      the violator of my decision, moderators are under no obligation to do so.
+
+4. If the the veracity of the report cannot be ascertained, the moderator will issue a warning to the violator informing
+   them that they have been reported for violating the rules.
+5. If a member of the community repeatedly reports another member or members and the veracity of their reports cannot be
+   determined, then the reporting member will receive a warning that they are in violation of the rules. (In other words,
+   don't report someone because you don't like them. You will be banned for doing so.)
+
+ALL ENFORCEMENT DECISIONS ARE AT THE DISCRETION OF THE MODERATORS OF THESE COMMUNITIES. ALL DECISIONS ARE FINAL AND
+MODERATORS ARE NOT OBLIGATED TO EXPLAIN OR JUSTIFY THEIR DECISIONS TO THOSE FOUND IN VIOLATION OF THE RULES OR THOSE WHO
+REPORT VIOLATIONS OF THE RULES.
+
+IN MAKING ENFORCEMENT DECISIONS, MODERATORS WILL ENSURE THAT BOTH THE ALLEGED VIOLATOR AND THE VIOLATION REPORTER SHALL
+RECEIVE FAIR CONSIDERATION BEFORE MAKING A DECISION.
+
+D. Changes to these Policies
+-------------------------
+At some point, community leadership may opt to make changes to these rules or the enforcement process.
+
+In the event that the rules change, they will be listed here in addition to the communities.
+
+In the event that the rules change, the changes shall apply to all existing community members.
+

docs/version.rst

@@ -0,0 +1,22 @@
+Version Information
+===================
+This page describes the meaning of the version number in addition to laying out what has changed in each release.
+
+Blinkter follows the `Semantic Versioning system <semver.org>`_ described on `semver.org <semver.org>`_. This means that
+the first element of the version number is the major version. When this number changes, it means that newer versions
+introduce backwards incompatible changes. The second element indicates that backwards compatible changes have been
+added to newer versions. Finally, the third number indicates that backwards compatible bug fixes have been introduced
+in newer versions.
+
+In other words, if you are worried that updating Blinkter will break your code, remember that everything should work
+the same for you as long as the major version has not changed.
+
+Changelog
+---------
+
+1.0.0-rc1
+~~~~~~~~~
+
+- Changed Versioning system to use `Semantic Versioning <semver.org>`_.
+- Rewrote the docs to be clearer and more descriptive.
+- Added information to the readme and docs about contacting the repository owner.

setup.py

@@ -21,13 +21,20 @@
 #  SOFTWARE.
 
 from setuptools import setup, find_packages
+import re
+
+def get_property(prop: str, project: str):
+    with open(project + '/__init__.py', 'r') as f:
+        return re.search(r'{}\s*=\s*[\'"]([\'"]*)[\'"]'.format(prop), f.read()).group(1)
 
 with open('README.md', 'r') as fh:
     long_description = fh.read()
 
+project_name = 'blinkter'
+
 setup(
-    name='blinkter',
-    version='0.1.5.6',
+    name=project_name,
+    version=get_property('__version__', project_name),
     packages=find_packages(),
     install_requires=['blinkt >= 0.1.2'],
     author='Andrew Luchuk',