https://github.com/rfdzan/python-pkghelp

A simple program to show internal dosctrings of external/internal python packages.
https://github.com/rfdzan/python-pkghelp

Last synced: about 2 months ago
JSON representation

A simple program to show internal dosctrings of external/internal python packages.

• Host: GitHub
• URL: https://github.com/rfdzan/python-pkghelp
• Owner: rfdzan
• License: mit
• Created: 2023-06-02T12:42:56.000Z (over 1 year ago)
• Default Branch: local
• Last Pushed: 2023-06-19T16:23:21.000Z (over 1 year ago)
• Last Synced: 2024-01-24T04:32:31.279Z (11 months ago)
• Language: Python
• Size: 365 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# python-pkghelp

A simple program to show internal dosctrings of external/internal python packages.  

`local` branch provides the barebones. Do `python main.py` in your terminal to use it.  

GUI app is pending.

## USAGE  

**Package/module name currently is case-sensitive, methods aren't**.

Type in the package/module and method as how you would in a python code:  

Example: `str.join`

```  

Package/module name: str.join

join

[('join', 100)]

Concatenate any number of strings.

The string whose method is called is inserted in between each given string.

The result is returned as a new string.

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

```

Or type in just the package/module to get a list of available methods:  

Example: `Levenshtein`  

```  

['_Editops', '_Hamming', '_Indel', '_Jaro', '_JaroWinkler', '_Levenshtein', '_Opcodes', '__all__', '__annotations__',   

'__author__', '__builtins__', '__cached__', '__doc__', '__file__', '__license__', '__loader__', '__name__', '__package__',   

'__path__', '__spec__', '__version__', 'apply_edit', 'distance', 'editops', 'hamming', 'inverse', 'jaro', 'jaro_winkler',   

'levenshtein_cpp', 'matching_blocks', 'median', 'median_improve', 'opcodes', 'quickmedian', 'ratio', 'seqratio', 'setmedian',   

'setratio', 'subtract_edit']

```