Skip to content

Commit

Permalink
Add more info
Browse files Browse the repository at this point in the history
  • Loading branch information
m-salewski committed Apr 8, 2021
1 parent 6f33396 commit b868d9c
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# pfynder

pfynder is a simple tool to find function, Object, and method names, usually in a Jupyter notebook.
## Intro

pfynder is a simple tool to find function, object, and method names, usually in a Jupyter notebook.

## Dependencies

It so far relies on a Linux environment, calling `find` and `grep` behind-the-scenes
and then presents it nicely on the screen.

It supports basic usage:
## Usage

It supports basic usage for searching a package (here "matplotlib") for a string ("xlim"):

```python
>>> from pfynder import pfynd
Expand All @@ -22,3 +28,10 @@ matplotlib
projections:
set_xlim
```

## Wishlist

Future development:
- search _all_ installed packages (also from other venvs)
- use pure python (e.g. `pkg-resources`)
- tab-completion (please help!)

0 comments on commit b868d9c

Please sign in to comment.