Skip to content

Commit

Permalink
change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Placidina committed Dec 16, 2018
1 parent 321ba24 commit 8d2f53b
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 31 deletions.
75 changes: 45 additions & 30 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,50 @@ defaults: &defaults
working_directory: ~/GetProxies

jobs:
test:
<<: *defaults
steps:
- checkout
- restore_cache:
keys:
- v1-dependencies-{{ checksum "requirements.txt" }}
- v1-dependencies-
- run:
name: Install Dependencies
command: pip install -r requirements.txt --use
- save_cache:
paths:
- ~/vendor
key: v1-dependencies-{{ checksum "requirements.txt" }}
- run:
name: Run Tests
command: python -c "import getproxies"
- run:
name: Setting Artifacts
command: mkdir -p /tmp/artifacts
- store_artifacts:
path: /tmp/artifacts
destination: tests
- store_test_results:
path: /tmp/artifacts
test:
<<: *defaults
steps:
- checkout
- restore_cache:
keys:
- v1-dependencies-{{ checksum "requirements.txt" }}
- v1-dependencies-
- run:
name: Install Dependencies
command: pip install -r requirements.txt --use
- save_cache:
paths:
- ~/vendor
key: v1-dependencies-{{ checksum "requirements.txt" }}
- run:
name: Run Tests
command: python -c "import getproxies"
- run:
name: Setting Artifacts
command: mkdir -p /tmp/artifacts
- store_artifacts:
path: /tmp/artifacts
destination: tests
- store_test_results:
path: /tmp/artifacts
deploy:
<<: *defaults
steps:
- checkout
- run:
name: No Action
command: exit 0

workflows:
version: 2
tests:
jobs:
- test
version: 2
tests:
jobs:
- test
- deploy:
requires:
- test
filters:
tags:
only: /.*/
branches:
ignore: /.*/
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
# GetProxies
[![Build Status](https://travis-ci.org/Placidina/GetProxies.svg?branch=master)](https://travis-ci.org/Placidina/GetProxies) [![Python 2.7](https://img.shields.io/badge/python-2.7-yellow.svg)](https://www.python.org/) [![License](https://img.shields.io/badge/license-GPLv3-red.svg)](https://github.com/Placidina/GetProxies/blob/master/LICENSE)

[![CircleCI](https://img.shields.io/circleci/project/github/Placidina/GetProxies.svg?style=popout-square")](https://circleci.com/gh/Placidina/GetProxies)
[![Python 2.7](https://img.shields.io/badge/python-2.7-yellow.svg)](https://www.python.org/)
[![License](https://img.shields.io/badge/license-GPLv3-red.svg)](https://github.com/Placidina/GetProxies/blob/master/LICENSE)

Bot to search free HTTP proxies

Screenshot

----

![Terminal](https://i.imgur.com/znTV1Cg.png)

Installation

----

Cloning the [Git](https://github.com/Placidina/GetProxies) repository
````
git clone https://github.com/Placidina/GetProxies.git
````

Install dependencies
```
$ python -m pip install -r requirements.txt
```
GetProxies works out of the box with [Python](http://www.python.org/download/) version 2.7.x on any platform.

Output

----

Output JSON result
Expand All @@ -35,11 +42,13 @@ Output JSON result
...
]
```

* Parameter `ip` of type `String` - IP of proxy
* Parameter `port` of type `Integir` - Port of proxy
* Parameter `ms` of type `null` or `String` - Proxy response time of argument `--check`

Arguments

----

```
Expand All @@ -58,6 +67,7 @@ Arguments
```

Usage

----

```
Expand Down

0 comments on commit 8d2f53b

Please sign in to comment.