/PyDoc

Primary LanguagePythonMIT LicenseMIT

PyDoc

PyDoc is a docset browser written in python for Pythonista.

Getting Started

To get started download this code to Pythonista:

  • Click the "Clone or download" button at the top right of this page
  • Click the "Download ZIP" link
  • Click the "More..." link
  • In the Share Sheet, click the "Run Pythonista Script" action
  • Click the "Import File" action, Click "OK", Click "Done"
  • Switch to Pythonista
  • Find the file "PyDoc-master.zip" and click on it
  • Click the "Extract Archive..." button
  • You can delete the file "PyDoc-master.zip" and to save space
  • Find the folder "PyDoc-master"

Then run the script PyDoc.py this will start the application.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

Docsets are provided by Dash the MacOS docset browser. Please checkout Dash please by clicking the link below.

Dash

Road Map

  • Add searching
  • Docset update functionality
  • Dark theme
  • Transfer functionality

Known Issues

  • Implement better error handling currently all errors are treated like they are fatal