Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/remove cli #50

Merged
merged 12 commits into from
Jan 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## naming structure
[action summary]_[triggering event]_[branch where applicable]
29 changes: 29 additions & 0 deletions .github/workflows/mvn-package_pr,push_main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Java CI with Maven

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'zulu'
cache: maven
- name: Package with Maven
run: mvn -B package -Dmvn.skip.test=true --file pom.xml

- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v3
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ jobs:
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin' # TODO: change to graalvm
distribution: 'zulu'
cache: maven
- name: Build with Maven
- name: Package with Maven
run: mvn -B package --file pom.xml

- name: Upload coverage reports to Codecov
Expand Down
Binary file added .mvn/wrapper/maven-wrapper.jar
Binary file not shown.
18 changes: 18 additions & 0 deletions .mvn/wrapper/maven-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
43 changes: 8 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,48 +8,21 @@

## Summary

Threshr is a cross-platform cli tool capable of querying product information from varying grocery stores.
Threshr is java library wrappper capable of querying product information from varying Target's various api's, aimed
at querying product pricing.

### Table of Contents

- [Install Instructions](#install)
- [Contributing](#want-to-get-involved)
### Usage

___
see tests for [examples](https://github.com/Graqr/Threshr/blob/e643e9a7bde831d73587da0e55ae8799a9b79ee2/src/test/groovy/com/graqr/threshr).

### Roadmap

Current store supported is Target, with Kroger, Walmart and Associated Foods on the horizon.

#### Target
I want to facilitate querying prices with these improvements:
- something easier than including target store ID's when specifying target store locations
- flesh out target's department & category information
- flesh out products which can be queried

Endpoints currently supported are the `pdp_client_v1` and `product_summary_with_fulfillment_v1` endpoints.
___
### Install

<details><summary>Windows</summary>
<ol>
<li>Download latest windows <a href="https://github.com/Graqr/Threshr/releases/latest">binary</a></li>
<li>Move executable to dedicated directory, ie <code>C:\Program Files\threshr\</code></li>
<li>Add directory to your PATH</li>

```PowerShell
"C:\Program Files\threshr\" |
if (!($env:Path -like "*$_*"))
{
$env:Path = "$( $env:Path );$_"
}
```

</ol>
</details>

<details><summary>Linux</summary>
<ol>
<li>Download latest linux <a href="https://github.com/Graqr/Threshr/releases/latest">binary</a></li>
<li>Add to <code>$HOME\bin\</code> directory</li>
</ol>
</details>

___

Expand Down
Loading