Skip to content

Commit d09b12e

Browse files
Add a simple readme
1 parent 7a21aa6 commit d09b12e

File tree

2 files changed

+47
-2
lines changed

2 files changed

+47
-2
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
1-
# daft-scraper
1+
# daft-scraper
2+
3+
- [daft-scraper](#daft-scraper)
4+
- [Install](#install)
5+
- [Via Pip](#via-pip)
6+
- [Via Git](#via-git)
7+
- [Example Usage](#example-usage)
8+
9+
10+
# Install
11+
12+
## Via Pip
13+
You can install the library using pip:
14+
15+
```
16+
pip install daft-scraper
17+
```
18+
19+
## Via Git
20+
The project uses [poetry](https://python-poetry.org/), so you'll need poetry to install the dependencies and setup the project.
21+
22+
```
23+
git clone [email protected]:TheJokersThief/daft-scraper.git
24+
cd daft-scraper
25+
make install
26+
```
27+
28+
# Example Usage
29+
30+
```python
31+
from daft_scraper.search import DaftSearch, SearchType
32+
from daft_scraper.search.options import (
33+
PropertyType, PropertyTypesOption, Facility, FacilitiesOption,
34+
PriceOption, BedOption
35+
)
36+
from daft_scraper.search.options_location import LocationsOption, Location
37+
38+
api = DaftSearch(SearchType.RENT)
39+
listings = api.search(options)
40+
41+
print(len(listings))
42+
for listing in listings:
43+
print(listing.get('title'))
44+
45+
```

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
[tool.poetry]
22
name = "daft-scraper"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
description = "A webscraper for Daft.ie"
55
authors = ["Evan Smith <[email protected]>"]
66
license = "MIT"
7+
readme = "README.md"
78

89
[tool.poetry.dependencies]
910
python = "^3.7"

0 commit comments

Comments
 (0)