Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wetransfer/wescan
Document Scanning Made Easy for iOS
https://github.com/wetransfer/wescan
ios scanner swift wt-branch-protection-exempt wt-branch-protection-two-approvals
Last synced: 2 days ago
JSON representation
Document Scanning Made Easy for iOS
- Host: GitHub
- URL: https://github.com/wetransfer/wescan
- Owner: WeTransfer
- License: mit
- Created: 2018-02-26T19:30:05.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T17:54:26.000Z (4 months ago)
- Last Synced: 2024-10-29T15:38:21.188Z (2 months ago)
- Topics: ios, scanner, swift, wt-branch-protection-exempt, wt-branch-protection-two-approvals
- Language: Swift
- Homepage:
- Size: 16.7 MB
- Stars: 2,851
- Watchers: 68
- Forks: 555
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# WeScan
**WeScan** makes it easy to add scanning functionalities to your iOS app!
It's modelled after `UIImagePickerController`, which makes it a breeze to use.
- [Features](#features)
- [Demo](#demo)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Features
- [x] Fast and lightweight
- [x] Live scanning of documents
- [x] Edit detected rectangle
- [x] Auto scan and flash support
- [x] Support for both PDF and UIImage
- [x] Translated to English, Chinese, Italian, Portuguese, and French
- [ ] Batch scanning
## Demo
## Requirements
- Swift 5.0
- iOS 10.0+
## Installation
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler. It is in early development, but WeScan does support its use on supported platforms.
Once you have your Swift package set up, adding WeScan as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/WeTransfer/WeScan.git", .upToNextMajor(from: "2.1.0"))
]
```
## Usage
### Swift
1. In order to make the framework available, add `import WeScan` at the top of the Swift source file
2. In the Info.plist, add the `NSCameraUsageDescription` key and set the appropriate value in which you have to inform the user of the reason to allow the camera permission
3. Make sure that your view controller conforms to the `ImageScannerControllerDelegate` protocol:
```swift
class YourViewController: UIViewController, ImageScannerControllerDelegate {
// YourViewController code here
}
```
4. Implement the delegate functions inside your view controller:
```swift
func imageScannerController(_ scanner: ImageScannerController, didFailWithError error: Error) {
// You are responsible for carefully handling the error
print(error)
}
func imageScannerController(_ scanner: ImageScannerController, didFinishScanningWithResults results: ImageScannerResults) {
// The user successfully scanned an image, which is available in the ImageScannerResults
// You are responsible for dismissing the ImageScannerController
scanner.dismiss(animated: true)
}
func imageScannerControllerDidCancel(_ scanner: ImageScannerController) {
// The user tapped 'Cancel' on the scanner
// You are responsible for dismissing the ImageScannerController
scanner.dismiss(animated: true)
}
```
5. Finally, create and present a `ImageScannerController` instance somewhere within your view controller:
```swift
let scannerViewController = ImageScannerController()
scannerViewController.imageScannerDelegate = self
present(scannerViewController, animated: true)
```
### Objective-C
1. Create a dummy swift class in your project. When Xcode asks if you'd like to create a bridging header, press 'Create Bridging Header'
2. In the new header, add the Objective-C class (`#import myClass.h`) where you want to use WeScan
3. In your class, import the header (`import `)
4. Drag and drop the WeScan folder to add it to your project
5. In your class, add `@Class ImageScannerController;`
#### Example Implementation
```objc
ImageScannerController *scannerViewController = [[ImageScannerController alloc] init];
[self presentViewController:scannerViewController animated:YES completion:nil];
```
## Contributing
As the creators, and maintainers of this project, we're glad to invite contributors to help us stay up to date. Please take a moment to review [the contributing document](CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved.
- If you **found a bug**, open an [issue](https://github.com/WeTransfer/WeScan/issues).
- If you **have a feature request**, open an [issue](https://github.com/WeTransfer/WeScan/issues).
- If you **want to contribute**, submit a [pull request](https://github.com/WeTransfer/WeScan/pulls).
## License
**WeScan** is available under the MIT license. See the [LICENSE](https://github.com/WeTransfer/WeScan/blob/develop/LICENSE) file for more info.