CodéNav

Web App for cleaning, searching, editing, and navigating Python code. Leverages cleandoc and snipsearch packages.

Install

pip install codenav

Usage

1. "cd" to directory containing Python code
2. "codenav" command in terminal
3. App will open automatically in current browser

1. Click on folder name to expand or contract the tree

2. OR click on caret-down to expand or contract the tree

3. Click on file to open contents in a tab

4. Click on x to close tab

5. Click on pencil button to edit the current file

6. Click in tab window and start editing

7. Add new line ' print("extra printout here") '

8. Click on Save button

9. Click run button to run the current file

10. Stop a script while it is running with "Stop" button

11. Click on 🔎 Search Code Content to search all code in the current directory

12. Type one or more search terms

13. Click on Open Snip to open the function or class with the most matches

14. Click on Open File button to open the entire file containing the snip

15. Click on New Tab button to create empty tab

16. Click "Up Folder" button to travel up one folder

17. Edit the path textbox to change the current directory

18. Click on "Clean File" button to run cleandoc on current file tab

Read The Docs

Download "docs" folder or check preview.

Contributing

Message me on Github.

License

GNU GPLv3

Copyright:

(c) 2023, Jason Krist