Skip to content

Commit d935c30

Browse files
committed
Update for v0.0.1
1 parent 180a5f6 commit d935c30

2 files changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
Class for retrieving data from Apify.io crawlers
1+
Simple client library for the excellent [apify.com API](https://www.apify.com/docs)
2+
## Installation
3+
### Using pip (Recommended)
4+
`pip install apify`
5+
### From source
6+
1. Clone this repository
7+
1. `python setup.py install`
8+
9+
## First use
10+
To ensure the module works, create a .json configuration file like the example `apify_config.json`, then run this python code:
11+
```python
12+
import apify
13+
print(apify.get_private_user_data(config=<CONFIG FILE>))
14+
```
15+
16+
## What you get
17+
* Most functions specified in the official API docs.
18+
* Object-oriented structure that follows the docs closely.
19+
* Fairly simple code
20+
* Bugs (probably)
21+
22+
## How to help
23+
* Contributing to this source code
24+
* Finding bugs! (then filing issues)
25+
* Suggesting ideas and improvements

apify/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
name = "apify"
12
from .Actor import Actor, Task
23
from .Crawler import Crawler, Execution
34
from .Dataset import Dataset

0 commit comments

Comments
 (0)