├── python-package-changelog.md
├── vscode-extension-changelog.md
└── README.md
/python-package-changelog.md:
--------------------------------------------------------------------------------
1 | # Python Package Changelog
2 |
3 | This changelog can now be found at [docs.kolo.app](https://docs.kolo.app/en/latest/python-changelog.html).
4 | The VSCode changelog can be found [here](https://docs.kolo.app/en/latest/vscode-changelog.html).
5 |
--------------------------------------------------------------------------------
/vscode-extension-changelog.md:
--------------------------------------------------------------------------------
1 | # VSCode Extension Changelog
2 |
3 | This changelog can now be found at [docs.kolo.app](https://docs.kolo.app/en/latest/vscode-changelog.html).
4 | The python package changelog can be found [here](https://docs.kolo.app/en/latest/python-changelog.html).
5 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Kolo
2 |
3 | Trace and visualize your Python code. Generate working tests.
4 |
5 | [](https://pypi.org/project/kolo/) [](https://discord.com/invite/FsTVcFwYUn)
6 |
7 | [](https://pypi.org/project/kolo/) [](https://pypi.org/project/kolo/)
8 |
9 | 📋 [docs.kolo.app](https://docs.kolo.app)
10 |
11 |
12 |
13 |
Screenshot of Kolo from the Todo Demo app
14 | 15 | 16 | ## Quickstart 17 | 18 | Getting started with Kolo only takes a couple of minutes. The fastest way to understand what Kolo does and how it can be helpful is by trying it out on a codebase you work on. But if you're in a hurry or can't try Kolo on your own codebase, you can preview some functionality in our [playground](https://play.kolo.app). 19 | 20 | 21 | ### Trace a Django request 22 | 23 | *Trace a Django request for inspection, visualization, and debugging purposes.* 24 | 25 | 26 | 1. Install kolo using `pip install kolo` 27 | 2. Add `"kolo.middleware.KoloMiddleware"` to the top of your MIDDLEWARE list in settings.py 28 | 3. Start your Django server using `python manage.py runserver` and make a request to any page. 29 | 4. Browse to `localhost:8000/_kolo/` to view your traced request. It should look similar to the screenshot at the top of the page 🚀 30 | 31 | 32 | (For a more in-depth version of this tutorial see [How to: Trace Django requests](https://docs.kolo.app/en/latest/howto/trace-django-requests.html)) 33 | 34 | 35 | ### Generate a test from your trace 36 | *Now that we have a trace recorded, we can generate a working integration test from that trace.* 37 | 38 | 1. Navigate from the "Trace" page to the "Test" page. 39 | 40 |