Skip to content

Commit

Permalink
Add how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
markowanga committed Dec 19, 2020
1 parent 1613aeb commit 9f7e3a3
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ st.GetUsersRunner(
users = users_collector.get_scrapped_users()
```

Stweet has a default `WebClient` implementation that is based on `requests` library — `st.RequestsWebClient`.
Class have all properties with default values, but by changing them user can set proxy or disable ssl verification.
Stweet has a default `WebClient` implementation that is based on `requests` library — `st.RequestsWebClient`. Class have
all properties with default values, but by changing them user can set proxy or disable ssl verification.

This snippet shows how to use it:

Expand Down Expand Up @@ -235,6 +235,21 @@ options that can be used in [requests.request](https://requests.readthedocs.io/e

Additionally, you can implement you own WebClient.

## How to contribute

If you want to improve stweet library then please read the instruction
in [first-contributions repo](https://github.com/firstcontributions/first-contributions). Remember to create pull
request to `develop` branch.

You must have `docker` and `docker-compose` to run all tests on your computer. These dependencies start the proxy
service which is required to run proxy tests. If you want to run tests locally please run `tox` command:

```bash
tox -v
```

Thank you for your every pull request. Together we can make this library better.

## Twint inspiration

Small part of library uses code from [twint](https://github.com/twintproject/twint). Twint was also main inspiration to
Expand Down

0 comments on commit 9f7e3a3

Please sign in to comment.