Merge branch 'release/0.11'

Author: Jack-Keene

.github/workflows/ci.yml

@@ -52,6 +52,11 @@ jobs:
     - name: Tests
       run: |
         pytest --cov=snowplow_tracker --cov-report=xml
+      
+    - name: Demo
+      run: |
+        cd examples
+        python app.py "localhost:9090"
 
     - name: Coveralls
       uses: AndreMiras/coveralls-python-action@develop

.github/workflows/documentation.yml

@@ -0,0 +1,20 @@
+name: documentation
+
+on:
+  push:
+    branches:    
+      - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+    - name: Deploy to GitHub Pages
+      if: success()
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html

.gitignore

@@ -41,3 +41,6 @@ nosetests.xml
 # Vagrant
 .vagrant
 VERSION
+
+#Docs
+docs/_build

CHANGES.txt

@@ -1,3 +1,13 @@
+Version 0.11.0 (2022-10-06)
+---------------------------
+Update README file (#264) 
+Update CONTRIBUTING.md file (#265) 
+Add API doc generation in CI (#277) 
+Add Demo App (#279) 
+Fix failing build in Dockerfile (#266) 
+Bump Copyright to 2022 (#271) 
+Update README.rst to README.md (#270)
+
 Version 0.10.0 (2021-12-16)
 --------------------------
 Add Python 3.10 support (#254)

CONTRIBUTING.md

@@ -4,7 +4,7 @@ The Snowplow Python Tracker is maintained by the Engineering team at Snowplow An
 
 We are extremely grateful for all contributions we receive, whether that is reporting an issue or a change to the code which can be made in the form of a pull request.
 
-For support requests, please use our community support Discourse forum: https://discourse.snowplowanalytics.com/.
+For support requests, please use our community support Discourse forum: https://discourse.snowplow.io/.
 
 ## Setting up an Environment
 
@@ -16,7 +16,7 @@ You should ensure you are comfortable building and testing the existing release
 
 ### Creating an issue
 
-The project contains an issue template which should help guiding you through the process. However, please keep in mind that support requests should go to our Discourse forum: https://discourse.snowplowanalytics.com/ and not GitHub issues.
+The project contains an issue template which should help guiding you through the process. However, please keep in mind that support requests should go to our Discourse forum: https://discourse.snowplow.io/ and not GitHub issues.
 
 It's also a good idea to log an issue before starting to work on a pull request to discuss it with the maintainers. A pull request is just one solution to a problem and it is often a good idea to talk about the problem with the maintainers first.
 
@@ -68,13 +68,13 @@ If your pull request is fairly chunky, there might be a non-trivial delay betwee
 ### Contributor license agreement
 
 We require outside contributors to sign a Contributor license agreement (or CLA) before we can merge their pull requests.  
-You can find more information on the topic in [the dedicated wiki page](https://github.com/snowplow/snowplow/wiki/CLA).  
+You can find more information on the topic in [the dedicated wiki page](https://docs.snowplow.io/docs/contributing/contributor-license-agreement/).  
 The @snowplowcla bot will guide you through the process.
 
 ## Getting in touch
 
 ### Community support requests
 
-Please do not log an issue if you are asking for support, all of our community support requests go through our Discourse forum: https://discourse.snowplowanalytics.com/.
+Please do not log an issue if you are asking for support, all of our community support requests go through our Discourse forum: https://discourse.snowplow.io/.
 
 Posting your problem there ensures more people will see it and you should get support faster than creating a new issue on GitHub. Please do create a new issue on GitHub if you think you've found a bug though!

Dockerfile

@@ -1,9 +1,12 @@
 FROM centos:8
+RUN cd /etc/yum.repos.d/
+RUN sed -i 's/mirrorlist/#mirrorlist/g' /etc/yum.repos.d/CentOS-*
+RUN sed -i 's|#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|g' /etc/yum.repos.d/CentOS-*
 
 RUN yum -y install wget
 RUN yum install -y epel-release
 RUN yum -y install git tar gcc make bzip2 openssl openssl-devel patch gcc-c++ libffi-devel sqlite-devel
-RUN git clone git://github.com/yyuu/pyenv.git ~/.pyenv
+RUN git clone https://github.com/yyuu/pyenv.git ~/.pyenv
 ENV HOME /root
 ENV PYENV_ROOT $HOME/.pyenv
 ENV PATH $PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2013-2021 Snowplow Analytics Ltd.
+   Copyright 2013-2022 Snowplow Analytics Ltd.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -0,0 +1,61 @@
+Python Analytics for Snowplow
+=============================
+
+[![Early Release](https://img.shields.io/static/v1?style=flat&label=Snowplow&message=Early%20Release&color=014477&labelColor=9ba0aa&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAeFBMVEVMaXGXANeYANeXANZbAJmXANeUANSQAM+XANeMAMpaAJhZAJeZANiXANaXANaOAM2WANVnAKWXANZ9ALtmAKVaAJmXANZaAJlXAJZdAJxaAJlZAJdbAJlbAJmQAM+UANKZANhhAJ+EAL+BAL9oAKZnAKVjAKF1ALNBd8J1AAAAKHRSTlMAa1hWXyteBTQJIEwRgUh2JjJon21wcBgNfmc+JlOBQjwezWF2l5dXzkW3/wAAAHpJREFUeNokhQOCA1EAxTL85hi7dXv/E5YPCYBq5DeN4pcqV1XbtW/xTVMIMAZE0cBHEaZhBmIQwCFofeprPUHqjmD/+7peztd62dWQRkvrQayXkn01f/gWp2CrxfjY7rcZ5V7DEMDQgmEozFpZqLUYDsNwOqbnMLwPAJEwCopZxKttAAAAAElFTkSuQmCC)](https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/tracker-maintenance-classification/)[![Build Status](https://github.com/snowplow/snowplow-python-tracker/actions/workflows/ci.yml/badge.svg)](https://github.com/snowplow/snowplow-python-tracker/actions)[![Test Coverage](https://img.shields.io/coveralls/github/snowplow/snowplow-python-tracker)](https://coveralls.io/github/snowplow/snowplow-python-tracker?branch=master) [![image](http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
+
+
+[![Pypi Snowplow Tracker](https://img.shields.io/pypi/v/snowplow-tracker)](https://pypi.org/project/snowplow-tracker/)[![Python Versions](https://img.shields.io/pypi/pyversions/snowplow-tracker)](https://pypi.org/project/snowplow-tracker/)[![Monthly Downloads](https://img.shields.io/pypi/dm/snowplow-tracker)](https://pypi.org/project/snowplow-tracker/)
+
+Overview
+--------
+
+Add analytics to your Python apps and Python games with the
+[Snowplow](http://snowplow.io) event tracker for
+[Python](http://python.org).
+
+With this tracker you can collect event data from your Python-based
+applications, games or Python web servers/frameworks.
+
+Find out more
+-------------
+
+  ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+  | Snowplow Docs | API Docs  | Contributing |
+  |     :----:     |     :----:   |     :----:   |
+  | ![techdocs](https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png) | ![setup](https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png) |                                                ![contributing](https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png) |
+  | [Snowplow Docs](https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/python-tracker/) | [API Docs](https://snowplow.github.io/snowplow-python-tracker/index.html)| [Contributing](https://github.com/snowplow/snowplow-python-tracker/blob/master/CONTRIBUTING.md) |                                                                              
+  --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+Python Support
+--------------
+
+| Python version | snowplow-tracker version |
+|     :----:     |     :----:               |
+| \>=3.5         | > 0.10.0                 |
+| 2.7            | > 0.9.1                  |
+
+Maintainer Quickstart
+---------------------
+
+Assuming [docker](https://www.docker.com/) is installed
+
+    host$ git clone [email protected]:snowplow/snowplow-python-tracker.git
+    host$ cd snowplow-python-tracker
+    host$ docker build -t snowplow-python-tracker . && docker run snowplow-python-tracker
+
+Copyright and license
+---------------------
+
+The Snowplow Python Tracker is copyright 2013-2022 Snowplow Analytics
+Ltd.
+
+Licensed under the [Apache License, Version
+2.0](http://www.apache.org/licenses/LICENSE-2.0) (the \"License\"); you
+may not use this software except in compliance with the License.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \"AS IS\" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.