From df4bc263d3f556ea6529d0c2d752b09f25ec9a31 Mon Sep 17 00:00:00 2001 From: "Yuma.M" Date: Mon, 25 Feb 2019 23:58:18 +0900 Subject: [PATCH] Use README.md for long description --- .travis.yml | 12 +---- README.md | 2 +- README.rst | 130 --------------------------------------------------- docs/conf.py | 6 +-- setup.py | 3 +- 5 files changed, 8 insertions(+), 145 deletions(-) delete mode 100644 README.rst diff --git a/.travis.yml b/.travis.yml index 5707635..6200040 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,14 +1,11 @@ +dist: xenial language: python python: - "2.7" - - "3.2" - - "3.3" - "3.4" - "3.5" - - "3.5-dev" - "3.6" - - "3.6-dev" - - "3.7-dev" + - "3.7" - "nightly" install: @@ -17,11 +14,6 @@ install: script: - python setup.py test -before_deploy: - - sudo apt-get -qq update - - sudo apt-get install -y pandoc - - pandoc -f markdown -t rst -o README.rst README.md - deploy: provider: pypi user: yuma-m diff --git a/README.md b/README.md index a38c759..0989eba 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ True ## Supported Python Versions - 2.7 -- 3.3 and above +- 3.4 and above ## Links - PyPI: https://pypi.python.org/pypi/pychord diff --git a/README.rst b/README.rst deleted file mode 100644 index 93c949d..0000000 --- a/README.rst +++ /dev/null @@ -1,130 +0,0 @@ -pychord |Build Status| |Documentation Status| -============================================= - -Overview --------- - -Pychord is a python library to handle musical chords. - -Installation ------------- - -.. code:: sh - - $ pip install pychord - -Basic Usage ------------ - -Create a Chord -~~~~~~~~~~~~~~ - -.. code:: python - - >>> from pychord import Chord - >>> c = Chord("Am7") - >>> c - - >>> c.info() - """ - Am7 - root=A - quality=m7 - appended=[] - on=None - """ - -Transpose a Chord -~~~~~~~~~~~~~~~~~ - -.. code:: python - - >>> c = Chord("Am7/G") - >>> c.transpose(3) - >>> c - - -Get component notes -~~~~~~~~~~~~~~~~~~~ - -.. code:: python - - >>> c = Chord("Am7") - >>> c.components() - ['A', 'C', 'E', 'G'] - -Compare Chords -~~~~~~~~~~~~~~ - -.. code:: python - - >>> Chord("C") == Chord("D") - False - >>> Chord("C#") == Chord("Db") - True - >>> c = Chord("C") - >>> c.transpose(2) - >>> c == Chord("D") - True - -Find Chords -~~~~~~~~~~~ - -.. code:: python - - >>> from pychord import note_to_chord - >>> note_to_chord(["C", "E", "G"]) - [] - >>> note_to_chord(["F#", "A", "C", "D"]) - [] - >>> note_to_chord(["F", "G", "C"]) - [, ] - -Create and handle chord progressions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code:: python - - >>> from pychord import ChordProgression - >>> cp = ChordProgression(["C", "G/B", "Am"]) - >>> cp - - - >>> cp.append("Em/G") - >>> cp - - - >>> cp.transpose(+3) - >>> cp - - - >>> cp[1] - - -Supported Python Versions -------------------------- - -- 2.7 -- 3.3 and above - -Links ------ - -- PyPI: https://pypi.python.org/pypi/pychord -- GitHub: https://github.com/yuma-m/pychord -- Documentation: http://pychord.readthedocs.io/en/latest/ - -Author ------- - -- `Yuma Mihira `__ - -License -------- - -- MIT License - -.. |Build Status| image:: https://travis-ci.org/yuma-m/pychord.svg?branch=master - :target: https://travis-ci.org/yuma-m/pychord -.. |Documentation Status| image:: https://readthedocs.org/projects/pychord/badge/?version=latest - :target: http://pychord.readthedocs.io/en/latest/?badge=latest diff --git a/docs/conf.py b/docs/conf.py index a3522a4..c34dd30 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,15 +40,15 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] +# source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = u'pychord' -copyright = u'2016, Yuma Mihira' +copyright = u'2016 - 2019, Yuma Mihira' author = u'Yuma Mihira' # The version info for the project you're documenting, acts as replacement for diff --git a/setup.py b/setup.py index 16574b0..bad3e3a 100644 --- a/setup.py +++ b/setup.py @@ -24,6 +24,7 @@ packages=find_packages(exclude=['test']), include_package_data=True, zip_safe=True, - long_description=open('README.rst').read(), + long_description=open('README.md').read(), + long_description_content_type='text/markdown', test_suite='test', )