lookyloo/README.md

89 lines
3.5 KiB
Markdown
Raw Normal View History

[![Lookyloo icon](website/web/static/lookyloo.jpeg)](https://www.lookyloo.eu/docs/main/index.html)
2020-12-22 13:16:45 +01:00
2021-03-23 15:11:12 +01:00
*[Lookyloo](https://lookyloo.circl.lu/)* is a web interface that captures a webpage and then displays a tree of the domains, that call each other.
2019-05-27 15:36:49 +02:00
[![Gitter](https://badges.gitter.im/Lookyloo/community.svg)](https://gitter.im/Lookyloo/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
2020-12-23 20:38:18 +01:00
2020-12-22 13:16:45 +01:00
* [What is Lookyloo?](#whats-in-a-name)
2021-09-07 16:44:49 +02:00
* [REST API](#rest-api)
* [Install Lookyloo](#installation)
* [Lookyloo Client](#python-client)
2020-12-23 20:38:18 +01:00
* [Contributing to Lookyloo](#contributing-to-lookyloo)
* [Code of Conduct](#code-of-conduct)
2020-12-23 20:38:18 +01:00
* [Support](#support)
* [Security](#security)
* [Credits](#credits)
* [License](#license)
2021-03-23 15:11:12 +01:00
## What's in a name?!
2017-07-23 19:56:51 +02:00
```
2021-03-23 15:11:12 +01:00
Lookyloo ...
2020-11-16 23:42:50 +01:00
2017-07-23 19:56:51 +02:00
Same as Looky Lou; often spelled as Looky-loo (hyphen) or lookylou
2020-11-16 23:42:50 +01:00
1. A person who just comes to look.
2. A person who goes out of the way to look at people or something, often causing crowds and disruption.
3. A person who enjoys watching other people's misfortune. Oftentimes car onlookers that stare at a car accidents.
In L.A., usually the lookyloos cause more accidents by not paying full attention to what is ahead of them.
```
Source: [Urban Dictionary](https://www.urbandictionary.com/define.php?term=lookyloo)
2017-07-23 19:56:51 +02:00
2020-11-16 23:42:50 +01:00
## No, really, what is Lookyloo?
2020-01-23 15:03:36 +01:00
2020-11-16 23:51:48 +01:00
Lookyloo is a web interface that allows you to capture and map the journey of a website page.
2020-11-16 23:42:50 +01:00
Find all you need to know about Lookyloo on our [documentation website](https://www.lookyloo.eu/docs/main/index.html).
2020-01-23 15:03:36 +01:00
2020-11-16 23:46:54 +01:00
Here's an example of a Lookyloo capture of the site **github.com**
![Screenshot of Lookyloo capturing Github](https://www.lookyloo.eu/docs/main/_images/sample_github.png)
2017-08-12 19:11:02 +02:00
2021-09-07 16:44:49 +02:00
# REST API
The API is self documented with swagger. You can play with it [on the demo instance](https://lookyloo.circl.lu/doc/).
2020-11-16 23:42:50 +01:00
2019-01-23 15:13:29 +01:00
# Installation
Please refer to the [install guide](https://www.lookyloo.eu/docs/main/install-lookyloo.html).
2020-11-16 23:42:50 +01:00
# Python client
`pylookyloo` is the recommended client to interact with a Lookyloo instance.
2017-08-12 20:40:08 +02:00
2020-11-16 23:42:50 +01:00
It is avaliable on PyPi, so you can install it using the following command:
```bash
pip install pylookyloo
```
2021-03-23 15:11:12 +01:00
For more details on `pylookyloo`, read the overview [docs](https://www.lookyloo.eu/docs/main/pylookyloo-overview.html), the [documentation](https://pylookyloo.readthedocs.io/en/latest/) of the module itself, or the code in this [GitHub repository](https://github.com/Lookyloo/PyLookyloo).
# Contributing to Lookyloo
To learn more about contributing to Lookyloo, see our [contributor guide](https://www.lookyloo.eu/docs/main/contributing.html).
2020-12-23 20:45:36 +01:00
### Code of Conduct
2020-12-24 05:10:53 +01:00
At Lookyloo, we pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. You can access our Code of Conduct [here](https://github.com/Lookyloo/lookyloo/blob/main/code_of_conduct.md) or on the [Lookyloo docs site](https://www.lookyloo.eu/docs/main/code-conduct.html).
# Support
2020-12-23 20:51:46 +01:00
* To engage with the Lookyloo community contact us on [Gitter](https://gitter.im/lookyloo-app/community).
2021-03-23 15:11:12 +01:00
* Let us know how we can improve Lookyloo by opening an [issue](https://github.com/Lookyloo/lookyloo/issues/new/choose).
2020-12-23 20:51:46 +01:00
* Follow us on [Twitter](https://twitter.com/lookyloo_app).
2020-12-23 20:45:36 +01:00
### Security
To report vulnerabilities, see our [Security Policy](lookyloo/SECURITY.md).
2020-12-23 20:45:36 +01:00
### Credits
Thank you very much [Tech Blog @ willshouse.com](https://techblog.willshouse.com/2012/01/03/most-common-user-agents/) for the up-to-date list of UserAgents.
2020-12-23 20:45:36 +01:00
### License
See our [LICENSE](LICENSE).