rob
/
elixir-amazon-history
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Rob Watson 2018-04-09 13:51:58 +02:00
parent f24fa96a9e
commit 821daa5412
1 changed files with 28 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,21 +1,36 @@
# AmazonHistory # AmazonHistory
**TODO: Add description** A side-project to help accomplish two outstanding tasks:
## Installation 1. Store a permanent record of the purchase history of an Amazon account
2. Learn [Elixir](https://elixir-lang.org/)
If [available in Hex](https://hex.pm/docs/publish), the package can be installed ## Description
by adding `amazon_history` to your list of dependencies in `mix.exs`:
```elixir This module uses [Hound](https://github.com/HashNuke/hound) and [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) to scrape the purchase history of an Amazon retail account, and output it in CSV format.
def deps do
[ ## Usage
{:amazon_history, "~> 0.1.0"}
] The project can be run from the command-line using `mix`.
end
For example:
```
mix run -e AmazonHistory.CLI.run(["--email", "amazon@email.com", "--password", "amaz0np4ssword", "--start-year", "2004"])
``` ```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) ## TODO/Wishlist
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/amazon_history](https://hexdocs.pm/amazon_history).
* Separate the scraping and parsing concerns. This is somewhat difficult to do due to the implementation of Hound, but would significantly ease the implementation of automated testing if it could be done.
* Expose more configuration to the CLI
* Bundle as an standalone executable(?)
## License
Copyright 2018 Rob Watson
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.