Skip to content

Commit

Permalink
update readme, docs (closes #315, #250)
Browse files Browse the repository at this point in the history
  • Loading branch information
sigma67 committed Aug 20, 2023
1 parent 2be108e commit 0ef4656
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,17 @@ Features
* upload songs and remove them again
* list uploaded songs, artists and albums

| **Localization**:
* all regions are supported (see `locations FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html#which-values-can-i-use-for-locations>`__
* 16 languages are supported (see `languages FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html#which-values-can-i-use-for-languages>`__


If you find something missing or broken,
check the `FAQ <https://ytmusicapi.readthedocs.io/en/stable/faq.html>`__ or
feel free to create an `issue <https://github.com/sigma67/ytmusicapi/issues/new/choose>`__.


Usage
------
.. code-block:: python
Expand Down
69 changes: 68 additions & 1 deletion docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@ Can I download songs?
***********************************************************************
You can use `youtube-dl <https://github.com/ytdl-org/youtube-dl/>`_ for this purpose.

How do I package ytmusicapi with ``pyinstaller``?
*************************************************

To package ytmusicapi correctly, you need to add the locales files to your executable.

You can use ``--add-data path-to-ytmusicapi/locales`` or ``--collect-all ytmusicapi`` to accomplish this.


YouTube Music API Internals
------------------------------
Expand Down Expand Up @@ -93,10 +100,70 @@ indicates the server-side pagination increment. ytmusicapi will keep fetching co
reached at least the ``limit`` parameter, and return all of these results.


Which values can I use for languages?
*************************************

The `language` parameter determines the language of the returned results.
``ytmusicapi`` only supports a subset of the languages supported by YouTube Music, as translations need to be done manually.
Contributions are welcome, see `here for instructions <https://github.com/sigma67/ytmusicapi/tree/master/ytmusicapi/locales>`__.

For the list of values you can use for the ``language`` parameter, see below:

.. raw:: html

<details>
<summary><a>Supported locations</a></summary>

.. container::

.. list-table::

* - Language
- Value
* - Arabic
- ar
* - German
- de
* - English (default)
- en
* - Spanish
- es
* - French
- fr
* - Hindi
- hi
* - Italian
- it
* - Japanese
- ja
* - Korean
- ko
* - Dutch
- nl
* - Portuguese
- pt
* - Russian
- ru
* - Turkish
- tr
* - Urdu
- ur
* - Chinese (Mainland)
- zh_CN
* - Chinese (Taiwan)
- zh_TW


.. raw:: html

</details>



Which values can I use for locations?
*************************************

Pick a value from the list below for your desired location and pass it using the `location` parameter.
Pick a value from the list below for your desired location and pass it using the ``location`` parameter.

.. raw:: html

Expand Down

0 comments on commit 0ef4656

Please sign in to comment.