Merge pull request #38 from titus-ong/merge-colab-with-github

Move Colab notebook to repository and update links

README.rst

@@ -2,24 +2,28 @@ chordparser
 ===========
 
 .. image:: https://travis-ci.com/titus-ong/chordparser.svg?branch=master
-   :alt: build status
+   :alt: Build status
    :target: https://travis-ci.com/titus-ong/chordparser
 
 .. image:: https://readthedocs.org/projects/chordparser/badge/?version=latest
     :target: https://chordparser.readthedocs.io/en/latest/?badge=latest
-    :alt: Documentation Status
+    :alt: Documentation status
 
 .. image:: https://coveralls.io/repos/github/titus-ong/chordparser/badge.svg?branch=master
-   :alt: coverage
+   :alt: Coverage
    :target: https://coveralls.io/github/titus-ong/chordparser
 
 .. image:: https://img.shields.io/pypi/v/chordparser.svg
    :target: https://pypi.org/pypi/chordparser
-   :alt: downloads
+   :alt: Downloads
 
 .. image:: https://img.shields.io/pypi/pyversions/chordparser.svg
    :target: https://pypi.org/pypi/chordparser
-   :alt: downloads
+   :alt: Downloads
+
+.. image:: https://colab.research.google.com/assets/colab-badge.svg
+   :target: https://colab.research.google.com/github/titus-ong/chordparser/blob/master/notebooks/chordparser-tutorial.ipynb
+   :alt: Open in Colab
 
 chordparser is a Python 3 package that provides a musical framework to analyse chords. Chord notation can be parsed into Chords, which can then be analysed against other chords or the key of the song. This allows for harmonic analysis in chord sheets and helps musicians understand why and how chord progressions work.
 
@@ -75,7 +79,7 @@ To install chordparser, run this command in your terminal:
 Usage
 -----
 
-Check out the `Colab notebook <https://colab.research.google.com/drive/1T5WcH2WMHqpqbJrzxDt_Mg03lw1aXho7?usp=sharing>`_, which runs through a working example to showcase chordparser's functions and help you get started on using it.
+Check out the `Colab notebook <https://colab.research.google.com/github/titus-ong/chordparser/blob/master/notebooks/chordparser-tutorial.ipynb>`_, which runs through a working example to showcase chordparser's functions and help you get started on using it.
 
 The full documentation can be found `here <https://chordparser.readthedocs.io/en/latest/>`_.
 

docs/index.rst

@@ -3,7 +3,7 @@ Welcome to chordparser's documentation!
 
 chordparser is a Python 3 package that provides a musical framework for analysing chords. The :doc:`Introduction <introduction>` covers what it is and why it is.
 
-If you are a musician, not a programmer, and you just want to see chordparser in action, the `Colab notebook <https://colab.research.google.com/drive/1T5WcH2WMHqpqbJrzxDt_Mg03lw1aXho7?usp=sharing>`_ is for you. It showcases the functions of chordparser and you can even use it for your own chord sheets without knowing any programming!
+If you are a musician, not a programmer, and you just want to see chordparser in action, the `Colab notebook <https://colab.research.google.com/github/titus-ong/chordparser/blob/master/notebooks/chordparser-tutorial.ipynb>`_ is for you. It showcases the functions of chordparser and you can even use it for your own chord sheets without knowing any programming!
 
 If you are a programmer however, then get started with :doc:`Installation <installation>` and jump right into using chordparser with the :doc:`hands-on Tutorial <tutorial>`. The :doc:`How-to guides <howto/main>` provide step-by-step guides on using different aspects of chordparser, while the :doc:`Reference <reference/main>` gives a full technical reference to all of chordparser's classes. Finally, the :doc:`Background <background/main>` section provides explanation and discussion of key topics.
 

docs/tutorial.rst

@@ -1,4 +1,4 @@
 Tutorial
 ========
 
-chordparser's tutorial can be found at the `Colab notebook <https://colab.research.google.com/drive/1T5WcH2WMHqpqbJrzxDt_Mg03lw1aXho7?usp=sharing>`_. Simply follow along the code cells, and you'll learn how to write a script that can read a chord sheet, transpose it, convert the chords to roman numeral notation and analyse them.
+chordparser's tutorial can be found at the `Colab notebook <https://colab.research.google.com/github/titus-ong/chordparser/blob/master/notebooks/chordparser-tutorial.ipynb>`_. Simply follow along the code cells, and you'll learn how to write a script that can read a chord sheet, transpose it, convert the chords to roman numeral notation and analyse them.