README.md
<p align="center" width="100%">
<img width="33%" src="https://github.com/browser-history/browser-history/blob/master/logo.png?raw=true">
</p>
<h1 align="center"> browser-history</h1>
[](https://browser-history.readthedocs.io/en/latest/?badge=latest)
[](https://badge.fury.io/py/browser-history)
[](https://codecov.io/gh/browser-history/browser-history)
[](https://github.com/psf/black)
[](https://codeclimate.com/github/browser-history/browser-history/maintainability)
``browser-history`` is a simple, zero-dependencies, developer-friendly python
package to retrieve (almost) any browser's history on (almost) any platform.
## Features
- Supports most **popular browsers**. See [this](https://browser-history.readthedocs.io/en/latest/browsers.html) for a full list.
- Supports all major platforms - **Windows, Mac and Linux**.
- A **command-line tool**: simply run `browser-history --help` from your terminal.
- **History**: browsing history with exact timestamp and URL.
- **Bookmarks**: browser bookmarks with timestamp, URL, title and folder.
- Lightweight: the entire package is less than 20kB in size and has no dependencies other than python 3.8+.
- Developer friendly: you can add support for new browsers or add a new feature very easily.
- Default browser: can automatically determine the default browser on Windows and Linux (`browser-history -b default`).
- Fully open source: this project is developed and maintained by the [`browser-history` organization](https://github.com/browser-history) (previously maintained by [PESOS](https://github.com/pesos)) and will always be open source (with the Apache 2.0 License).
# Quick Start
## Installation
To install the latest release:
```
pip install browser-history
```
To install from the master branch (warning: development version. Things could break)
```
pip install git+https://github.com/browser-history/browser-history.git
```
## Usage
### History
To get history from all installed browsers:
```python
from browser_history import get_history
outputs = get_history()
# his is a list of (datetime.datetime, url) tuples
his = outputs.histories
```
If you want history from a specific browser:
```python
from browser_history.browsers import Firefox
f = Firefox()
outputs = f.fetch_history()
# his is a list of (datetime.datetime, url) tuples
his = outputs.histories
```
- `Firefox` in the above snippet can be replaced with any of the [supported browsers](https://browser-history.readthedocs.io/en/latest/browsers.html).
### Bookmarks
WARNING: Experimental feature. Although this has been confirmed to work on multiple (Firefox and Chromium based) browsers
on all platforms, it is not covered by tests and has not been used as much as the history feature.
To get bookmarks from all installed browsers:
```python
from browser_history import get_bookmarks
outputs = get_bookmarks()
# bms is a list of (datetime.datetime, url, title, folder) tuples
bms = outputs.bookmarks
```
To get bookmarks from a specific browser:
```python
from browser_history.browsers import Firefox
f = Firefox()
outputs = f.fetch_bookmarks()
# bms is a list of (datetime.datetime, url, title, folder) tuples
bms = outputs.bookmarks
```
Check out the [documentation](https://browser-history.readthedocs.io/en/latest/) for more details.
# Supported Browsers
Read the [documentation](https://browser-history.readthedocs.io/en/latest/browsers.html)
# Credits
Logo designed with :heart: by [XA](https://github.com/XAMES3).
# License
Licensed under the [Apache License, Version 2.0 (the "License")](LICENSE)