solfege.scale
=============

.. py:module:: solfege.scale

.. autoapi-nested-parse::

   Classes to represent a scale of notes.



Classes
-------

.. autoapisummary::

   solfege.scale.ScaleType
   solfege.scale.Scale


Module Contents
---------------

.. role:: raw-html(raw)
    :format: html
.. py:class:: ScaleType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Supported scale types.

:raw-html:`<br />`
   .. py:attribute:: MAJOR
      :value: 0


      Enum for selecting a Major scale.

:raw-html:`<br />`
   .. py:attribute:: MINOR

      Enum for selecting a Natural Minor scale.


.. role:: raw-html(raw)
    :format: html
.. py:class:: Scale(starting_note, type = ScaleType.MAJOR)

   A representation of a musical scale.

:raw-html:`<br />`
   .. py:method:: solfege(note_)

      Get the movable-do solfege name for a note in this scale.

      For minor keys, moving-do la-based minor is used.

      :param note_: The note in question.
      :type note_: note.Note

      :returns: The solfege name for that note.
      :rtype: str