Skip to content

Commit

Permalink
Created a new table in README.rst demonstrating what needs to happen …
Browse files Browse the repository at this point in the history
…in order for ALL things to work in Plexstuff. Also, update to one location to run Plexstuff where everything works.

Changes to be committed:
	modified:   README.rst
	modified:   docs/source/create_exec_covg.py
	modified:   docs/source/plex-config/plex-config-gui-figures/plex_config_gui_serviceswidget.png
  • Loading branch information
tanimislam committed Nov 10, 2019
1 parent b9da54f commit cf248e0
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,40 @@ The command line tools are built using Python's OptionParser_ module, and the GU

The comprehensive documentation lives in HTML created with `Sphinx <http://www.sphinx-doc.org/en/master/>`_, and now in the `Read the Docs <Plexstuff_>`_ page for this project. To generate the documentation, go to the ``docs`` subdirectory. In that directory, run ``make html``. Load ``docs/build/html/index.html`` into a browser to see the documentation.

Quick and Dirty -- How Do I Get It Working?
--------------------------------------------
Although discussed in the `Sphinx documentation <Plexstuff_>`_, to get everything working you need pandoc_, sshpass_, and PyQt5_. Getting all this on Linux machines is probably more straightforward than on Macs and Windows machines.

To be able to use all the CLIs, GUIs, and API functionality, there are ``12`` sets of configurations that need to work: four for login, four for credentials, and four for music.

.. |main_config_gui| image:: https://plexstuff.readthedocs.io/en/latest/_images/plex_config_gui_serviceswidget.png
:width: 100%
:align: middle

.. |login_config_gui| image:: https://plexstuff.readthedocs.io/en/latest/_images/plex_login_mainfigure.png
:width: 100%
:align: middle

.. |credentials_config_gui| image:: https://plexstuff.readthedocs.io/en/latest/_images/plex_credentials_mainfigure.png
:width: 100%
:align: middle

.. |music_config_gui| image:: https://plexstuff.readthedocs.io/en/latest/_images/plexmusic_mainfigure.png
:width: 100%
:align: middle

=========================================== =========================================== ====================================================== ===========================================
|main_config_gui| |login_config_gui| |credentials_config_gui| |music_config_gui|
`12 total settings <sec_main_config_gui_>`_ `4 login settings <sec_login_config_gui_>`_ `4 credential settings <sec_credentials_config_gui_>`_ `4 music settings <sec_music_config_gui_>`_
=========================================== =========================================== ====================================================== ===========================================

.. links to plexstuff sections
.. _sec_main_config_gui: https://plexstuff.readthedocs.io/en/latest/plex-config/plex_config_gui_usage.html
.. _sec_login_config_gui: https://plexstuff.readthedocs.io/en/latest/plex-config/plex_config_gui_usage.html#login-services
.. _sec_credentials_config_gui: https://plexstuff.readthedocs.io/en/latest/plex-config/plex_config_gui_usage.html#credentials-services
.. _sec_music_config_gui: https://plexstuff.readthedocs.io/en/latest/plex-config/plex_config_gui_usage.html#music-services


.. these are the links
.. _unofficial_plex_api: https://github.com/Arcanemagus/plex-api/wiki
Expand Down
17 changes: 17 additions & 0 deletions docs/source/create_exec_covg.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,29 @@ def _make_str( exc ):
( "`YTS API`_", ":py:meth:`get_movie_torrent <plextmdb.plextmdb_torrents.get_movie_torrent>`", True )
]

_table_showconfig_settings = [
( "|main_config_gui|", "|login_config_gui|", "|credentials_config_gui|", "|music_config_gui|" ),
( "`12 total settings <sec_main_config_gui_>`_",
"`4 login settings <sec_login_config_gui_>`_",
"`4 credential settings <sec_credentials_config_gui_>`_",
"`4 music settings <sec_music_config_gui_>`_" ) ]

if __name__ == '__main__':

print( 'WHICH CLIs and GUIs FINISHED\n' )
print( '%s\n' % ''.join( ['-'] * 50 ) )
print( tabulate.tabulate( _table, [ 'Functionality', 'CLI', 'GUI' ], tablefmt = 'rst' ) )
print('\n\n\n')
print( 'WHICH TV TORRENT SERVICES WORK\n' )
print( '%s\n' % ''.join( ['-'] * 50 ) )
print( tabulate.tabulate( _table_tvtorrents, [ "Torrent Service", "Search Method", "Does It Work?" ],
tablefmt = 'rst' ) )
print('\n\n\n')
print( 'WHICH TV TORRENT SERVICES WORK\n' )
print( '%s\n' % ''.join( ['-'] * 50 ) )
print( tabulate.tabulate( _table_movietorrents, [ "Torrent Service", "Search Method", "Does It Work?" ],
tablefmt = 'rst' ) )
print('\n\n\n')
print( 'WHICH CONFIGURATION SETTINGS\n' )
print( '%s\n' % ''.join( ['-'] * 50 ) )
print( tabulate.tabulate( _table_showconfig_settings, tablefmt = 'rst' ) )
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cf248e0

Please sign in to comment.