Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bdlukaa/books_finder
A library to help on the search for books on google books api
https://github.com/bdlukaa/books_finder
books-finder dart google-books google-books-api google-books-search
Last synced: 21 days ago
JSON representation
A library to help on the search for books on google books api
- Host: GitHub
- URL: https://github.com/bdlukaa/books_finder
- Owner: bdlukaa
- License: bsd-3-clause
- Created: 2020-08-28T00:22:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-30T23:02:59.000Z (over 1 year ago)
- Last Synced: 2024-10-08T22:13:57.301Z (about 1 month ago)
- Topics: books-finder, dart, google-books, google-books-api, google-books-search
- Language: Dart
- Homepage: https://pub.dev/packages/books_finder
- Size: 66.4 KB
- Stars: 21
- Watchers: 3
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
books_finder
A library to help on the search for books on the [Google Books Api](https://developers.google.com/books/docs/v1/using).
## Usage
First of all, import the library:
```dart
import 'package:books_finder/books_finder.dart';
```
### Querying books
To query books, just call the function `queryBooks`:
```dart
final List books = await queryBooks(
'twilight',
queryType: QueryType.intitle,
maxResults: 3,
printType: PrintType.books,
orderBy: OrderBy.relevance,
);
```
You can change a few parameters to make your query more specific:
| Parameter | Description | Nullable |
| ------------------ | ------------------------------------------ | -------- |
| queryType | Keywords to search in particular fields | Yes |
| maxResults | Set the max amount of results | No |
| startIndex | for pagination | No |
| langRestrict | Retrict the query to a specific language | Yes |
| orderBy | Order the query by newest or relevance | Yes |
| printType | Filter by books, magazines or both | Yes |
| reschemeImageLinks | Rescheme image urls from `http` to `https` | No |
### Books
If you already have a `Book` object, you can call `book.info` to get all the book infos:
```dart
final info = book.info;
```
| Parameter | Description |
| ----------------------------------------------- | ------------------------------------------- |
| title (`String`) | Title of the book |
| subtitle (`String`) | The subtile of the book |
| authors (`List`) | All the authors names |
| publisher (`String`) | The publisher name |
| publishedDate (`DateTime`) | The date it was published |
| rawPublishedDate (`String`) | The date it was published in raw format |
| description (`String`) | Description of the book |
| pageCount (`int`) | The amount of pages |
| categories (`List`) | The categories the book is in |
| averageRating (`double`) | The average rating of the book |
| ratingsCount (`int`) | The amount of people that rated it |
| maturityRating (`String`) | The maturity rating |
| contentVersion (`String`) | The version of the content |
| industryIdentifier (`List`) | The identifiers of the book (isbn) |
| imageLinks (`List>`) | The links with the avaiable image resources |
| language (`String`) | The language code of the book |
## Acknowledgements
- [@JimTim](https://github.com/JimTim) for industry identifiers and tests
- [@Moomink](https://github.com/Moomink) for fixing `startIndex`
- [@niklasenberg](https://github.com/niklasenberg) for `BookInfo.subtitle` and `QueryType`
## Issues and feedback
Please file issues, bugs, or feature requests in our [issue tracker](https://github.com/bdlukaa/books_finder/issues/new).
To contribute a change to this plugin open a [pull request](https://github.com/bdlukaa/books_finder/pulls).