Skip to content

Commit

Permalink
Update repository name (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
a-maliarov committed Oct 14, 2020
1 parent 15e393b commit 751e52d
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 22 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Amazon Captcha Solver
# Contributing to AmazonCaptcha
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
Expand All @@ -21,7 +21,7 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/a-maliarov/amazon-captcha-solver/issues)
## Report bugs using Github's [issues](https://github.com/a-maliarov/amazoncaptcha/issues)
We use GitHub issues to track public bugs.

## Write bug reports with detail, background, and sample code
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ matrix:
- python: "3.5"

install:
- pip install git+https://github.com/a-maliarov/amazon-captcha-solver
- pip install git+https://github.com/a-maliarov/amazoncaptcha

before_script:
- wget -N https://chromedriver.storage.googleapis.com/86.0.4240.22/chromedriver_linux64.zip -P ~/
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The motivation behind the creation of this library is taking its start from the
---
Pure Python, lightweight, [Pillow](https://github.com/python-pillow/Pillow)-based solver for [Amazon's text captcha](https://www.amazon.com/errors/validateCaptcha).

[![Accuracy](https://img.shields.io/badge/success%20rate-99.9%25-success)](https://github.com/a-maliarov/amazon-captcha-solver/blob/master/ext/accuracy.log)
[![Accuracy](https://img.shields.io/badge/success%20rate-99.9%25-success)](https://github.com/a-maliarov/amazoncaptcha/blob/master/ext/accuracy.log)
![Timing](https://img.shields.io/badge/response%20time-0.2s-success)
[![Size](https://img.shields.io/badge/wheel%20size-0.9%20MB-informational)](https://pypi.org/project/amazoncaptcha/)
[![Version](https://img.shields.io/pypi/v/amazoncaptcha?color=informational)](https://pypi.org/project/amazoncaptcha/)
Expand Down Expand Up @@ -48,11 +48,11 @@ solution = captcha.solve()

## Status
[![Status](https://img.shields.io/pypi/status/amazoncaptcha)](https://pypi.org/project/amazoncaptcha/)
[![Build Status](https://travis-ci.com/a-maliarov/amazon-captcha-solver.svg?branch=master)](https://travis-ci.com/a-maliarov/amazon-captcha-solver)
[![Build Status](https://travis-ci.com/a-maliarov/amazoncaptcha.svg?branch=master)](https://travis-ci.com/a-maliarov/amazoncaptcha)
[![Documentation Status](https://readthedocs.org/projects/amazoncaptcha/badge/?version=latest)](https://amazoncaptcha.readthedocs.io/en/latest/)
[![Requirements Status](https://requires.io/github/a-maliarov/amazon-captcha-solver/requirements.svg?branch=master)](https://requires.io/github/a-maliarov/amazon-captcha-solver/requirements/?branch=master)
[![Code Coverage](https://img.shields.io/codecov/c/gh/a-maliarov/amazon-captcha-solver?label=code%20coverage)](https://codecov.io/gh/a-maliarov/amazon-captcha-solver)
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/a-maliarov/amazon-captcha-solver/master)](https://www.codefactor.io/repository/github/a-maliarov/amazon-captcha-solver/overview/master)
[![Requirements Status](https://requires.io/github/a-maliarov/amazoncaptcha/requirements.svg?branch=master)](https://requires.io/github/a-maliarov/amazoncaptcha/requirements/?branch=master)
[![Code Coverage](https://img.shields.io/codecov/c/gh/a-maliarov/amazoncaptcha?label=code%20coverage)](https://codecov.io/gh/a-maliarov/amazoncaptcha)
[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/a-maliarov/amazoncaptcha/master)](https://www.codefactor.io/repository/github/a-maliarov/amazoncaptcha/overview/master)

## Usage and Class Methods
Browsing Amazon using `selenium` and stuck on captcha? The class method below will do all the "dirty" work of extracting an image from the webpage for you. Practically, it takes a screenshot from your webdriver, crops the captcha, and stores it into bytes array, which is then used to create an `AmazonCaptcha` instance. This also means avoiding any local savings.
Expand Down Expand Up @@ -80,7 +80,7 @@ solution = captcha.solve()
In addition, if you are a machine learning or neural network developer and are looking for some training data, check [this](https://github.com/a-maliarov/amazon-captcha-database) repository, which was created to store images and other non-script data for the solver.

## Help the Development
If you are willing to help the development, consider setting `keep_logs` argument of the `solve` method to `True`. Here is the example, if you are using `fromdriver` class method. If set to `True`, all the links of the unsolved captcha will be stored, so later you can [open the issue and send the logs](https://github.com/a-maliarov/amazon-captcha-solver/issues/new?assignees=a-maliarov&labels=training+data&template=send_logs.md&title=Add+training+data).
If you are willing to help the development, consider setting `keep_logs` argument of the `solve` method to `True`. Here is the example, if you are using `fromdriver` class method. If set to `True`, all the links of the unsolved captcha will be stored, so later you can [open the issue and send the logs](https://github.com/a-maliarov/amazoncaptcha/issues/new?assignees=a-maliarov&labels=training+data&template=send_logs.md&title=Add+training+data).
```python
from amazoncaptcha import AmazonCaptcha
from selenium import webdriver
Expand All @@ -95,6 +95,6 @@ solution = captcha.solve(keep_logs=True)
If you have any suggestions or ideas of additional instances and methods, which you would like to see in this library, please, feel free to contact the owner via email or fork'n'pull to repository. Any contribution is highly appreciated!

## Additional
+ If you want to see the [**History of Changes**](https://github.com/a-maliarov/amazon-captcha-solver/blob/master/HISTORY.md), [**Code of Conduct**](https://github.com/a-maliarov/amazon-captcha-solver/blob/master/.github/CODE_OF_CONDUCT.md), [**Contributing Policy**](https://github.com/a-maliarov/amazon-captcha-solver/blob/master/.github/CONTRIBUTING.md), or [**License**](https://github.com/a-maliarov/amazon-captcha-solver/blob/master/LICENSE), use these inline links to navigate based on your needs.
+ If you want to see the [**History of Changes**](https://github.com/a-maliarov/amazoncaptcha/blob/master/HISTORY.md), [**Code of Conduct**](https://github.com/a-maliarov/amazoncaptcha/blob/master/.github/CODE_OF_CONDUCT.md), [**Contributing Policy**](https://github.com/a-maliarov/amazoncaptcha/blob/master/.github/CONTRIBUTING.md), or [**License**](https://github.com/a-maliarov/amazoncaptcha/blob/master/LICENSE), use these inline links to navigate based on your needs.
+ If you are facing any errors, please, report your situation via an issue.
+ This project is for educational and research purposes only. Any actions and/or activities related to the material contained on this GitHub Repository is solely your responsibility. The author will not be held responsible in the event any criminal charges be brought against any individuals misusing the information in this GitHub Repository to break the law.
2 changes: 1 addition & 1 deletion amazoncaptcha/__version__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
__title__ = 'amazoncaptcha'
__description__ = "Pure Python, lightweight, Pillow-based solver for Amazon's text captcha."
__url__ = 'https://github.com/a-maliarov/amazon-captcha-solver'
__url__ = 'https://github.com/a-maliarov/amazoncaptcha'
__version__ = '0.4.9'
__author__ = 'Anatolii Maliarov'
__author_email__ = 'tly.mov@gmail.com'
Expand Down
20 changes: 10 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ AmazonCaptcha
AmazonCaptcha is an image processing library oriented on `a specific type of images taken from Amazon <https://www.amazon.com/errors/validateCaptcha>`_, which main objective is to solve the captcha in terms of a research sake without using any add-ons.

.. image:: https://img.shields.io/badge/success%20rate-99.9%25-success
:target: https://github.com/a-maliarov/amazon-captcha-solver/blob/master/ext/accuracy.log
:target: https://github.com/a-maliarov/amazoncaptcha/blob/master/ext/accuracy.log
:alt: Accuracy

.. image:: https://img.shields.io/badge/response%20time-0.2s-success
:target: https://github.com/a-maliarov/amazon-captcha-solver/blob/master/ext/accuracy.log
:target: https://github.com/a-maliarov/amazoncaptcha/blob/master/ext/accuracy.log
:alt: Timing

.. image:: https://img.shields.io/badge/wheel%20size-0.9%20MB-informational
Expand All @@ -31,24 +31,24 @@ AmazonCaptcha is an image processing library oriented on `a specific type of ima
:target: https://pypi.org/project/amazoncaptcha/
:alt: Status

.. image:: https://travis-ci.com/a-maliarov/amazon-captcha-solver.svg?branch=master
:target: https://travis-ci.com/a-maliarov/amazon-captcha-solver
.. image:: https://travis-ci.com/a-maliarov/amazoncaptcha.svg?branch=master
:target: https://travis-ci.com/a-maliarov/amazoncaptcha
:alt: Build Status

.. image:: https://readthedocs.org/projects/amazoncaptcha/badge/?version=latest
:target: https://amazoncaptcha.readthedocs.io/en/latest/
:alt: Documentation Status

.. image:: https://requires.io/github/a-maliarov/amazon-captcha-solver/requirements.svg?branch=master
:target: https://requires.io/github/a-maliarov/amazon-captcha-solver/requirements/?branch=master
.. image:: https://requires.io/github/a-maliarov/amazoncaptcha/requirements.svg?branch=master
:target: https://requires.io/github/a-maliarov/amazoncaptcha/requirements/?branch=master
:alt: Requirements Status

.. image:: https://img.shields.io/codecov/c/gh/a-maliarov/amazon-captcha-solver?label=code%20coverage
:target: https://codecov.io/gh/a-maliarov/amazon-captcha-solver
.. image:: https://img.shields.io/codecov/c/gh/a-maliarov/amazoncaptcha?label=code%20coverage
:target: https://codecov.io/gh/a-maliarov/amazoncaptcha
:alt: Code Coverage

.. image:: https://img.shields.io/codefactor/grade/github/a-maliarov/amazon-captcha-solver/master
:target: https://www.codefactor.io/repository/github/a-maliarov/amazon-captcha-solver/overview/master
.. image:: https://img.shields.io/codefactor/grade/github/a-maliarov/amazoncaptcha/master
:target: https://www.codefactor.io/repository/github/a-maliarov/amazoncaptcha/overview/master
:alt: CodeFactor Grade

Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Install AmazonCaptcha from PyPi with :command:`pip`:

Install AmazonCaptcha from GitHub with :command:`git` and :command:`pip`:

pip install git+https://github.com/a-maliarov/amazon-captcha-solver.git
pip install git+https://github.com/a-maliarov/amazoncaptcha.git

Install AmazonCaptcha from GitHub after :command:`git clone`:

Expand Down

0 comments on commit 751e52d

Please sign in to comment.