Metadata-Version: 2.1
Name: craigapts
Version: 2020.2.23.1
Summary: Python package for scraping apartment data from Craigslist.
Home-page: https://gitlab.com/everetr/craigapts
Author: Everet Rummel
Author-email: 
License: LICENSE.txt
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
Requires-Dist: beautifulsoup4 (>=4.8.2)
Requires-Dist: pandas (>=1.0.1)
Requires-Dist: requests (>=2.23.0)


# craigapts

Python package for scraping apartment data from Craigslist.

## Install

Stable version from PyPI:

```sh
pip install craigapts
```

Dev version from GitLab:

```sh
pip install git+https://gitlab.com/everetr/craigapts.git
```

## Examples

```python3

from craigapts import CLSearch

GEO   = "newjersey"
QUERY = "'no section 8'"

# get basic data available on search result pages
c1 = CLSearch(GEO, QUERY)
print(c1.data)

# get details by navigating to each individual ad
c2 = CLSearch(GEO, QUERY, deep=True)
print(c2.data)

```

## Changelog

2020.2.23.1

* First release.

## TODO

* Add list of CL geographies
* Let user specify which variables, how many pages, and how many ads to scrape
* CLI


