peeter123 · mik1234mc · Jun 3, 2021 · Jun 3, 2021 · Jun 3, 2021 · Jun 3, 2021
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -0,0 +1,26 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+    container: setsoft/kicad_pybuild:latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python3 setup.py sdist bdist_wheel
+        twine upload dist/*
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,86 @@
+name: release
+
+on:
+  push:
+    tags-ignore:
+      - "v1"
+      - "v1_k6"
+      - "v2"
+      - "v2_k6"
+      - "v3"
+      - "v3_k6"
+      - "v4"
+      - "v4_k6"
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    outputs:
+      is_tag: ${{ steps.check.outputs.is_tag }}
+
+    steps:
+      - name: Check if it's a tagged release
+        id: check
+        run: |
+          REF=${{ github.ref }}
+          URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/releases/tags/${REF##*/}"
+          StatusCode=$(curl -o -I -L -s -w "%{http_code}" -X GET -G $URL)
+          echo $StatusCode
+          if [[ "$StatusCode" == 200 ]]; then
+            echo "This is tagged release!"
+            echo "::set-output name=is_tag::no"
+          else
+            echo "This is a tag not release!"
+            echo "::set-output name=is_tag::yes"
+          fi
+
+  build:
+    runs-on: ubuntu-latest
+    container: setsoft/kicad_pybuild:latest
+    needs: check
+    if: ${{ needs.check.outputs.is_tag == 'yes' }}
+    outputs:
+      deb_name: ${{ steps.mdeb.outputs.deb_name }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Build
+        id: mdeb
+        run: |
+          make deb
+          mv ../*.deb .
+          echo "::set-output name=deb_name::"`ls *.deb`
+          mkdir output
+          mv *.deb output
+
+      - name: Store
+        uses: actions/upload-artifact@v1
+        with:
+          name: package
+          path: output
+
+  release:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Retrieve
+        uses: actions/download-artifact@v1
+        with:
+          name: package
+
+      - name: Release
+        uses: docker://antonyurchenko/git-release:latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DRAFT_RELEASE: "false"
+          PRE_RELEASE: "false"
+          CHANGELOG_FILE: "CHANGELOG.md"
+        with:
+          args: |
+            package/${{needs.build.outputs.deb_name}}
+
diff --git a/.gitignore b/.gitignore
@@ -73,3 +73,5 @@ generate-v3-api/
 # Other repository dependent
 tests/local/
 .env/config.ini
+
+*.epr
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,26 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.3] - 2023-11-08
+### Added
+- Support for Python 3.12 (ssl.wrap_socket no longer available)
+
+## [0.1.2] - 2022-10-06
+### Added
+- Option to exclude marketpace products
+
+### Fixed
+- Problems when a Digi-Key query gives time-out
+
+## [0.1.1] - 2022-03-21
+### Fixed
+- Requirements
+
+## [0.1.0] - 2022-03-21
+### Added
+- First release
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include requirements.txt
diff --git a/Makefile b/Makefile
@@ -0,0 +1,13 @@
+#!/usr/bin/make
+
+deb:
+	DEB_BUILD_OPTIONS=nocheck fakeroot dpkg-buildpackage -uc -b
+
+deb_sig:
+	DEB_BUILD_OPTIONS=nocheck fakeroot dpkg-buildpackage -b
+
+deb_clean:
+	fakeroot debian/rules clean
+
+
+.PHONY: deb deb_clean
diff --git a/README.md b/README.md
@@ -1,143 +1,47 @@
-Python Client for Digikey API
+KiCost plug-in for Digi-Key API
 =================================
-Search for parts in the Digi-Key catalog by keyword using KeywordSearch. Then make a PartDetails call to retrieve all 
-real time information about the part including pricing. PartDetails works best with Digi-Key part numbers as some 
-manufacturers overlap other manufacturer part numbers.
+This is an experimental plug-in to allow KiCost to do native Digi-Key API requests.
 
-[![Pypi](https://img.shields.io/pypi/v/digikey-api.svg?color=brightgreen)](https://pypi.org/project/digikey-api/) 
-[![Donate](https://img.shields.io/badge/Donate-PayPal-gold.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=53HWHHVCJ3D4J&currency_code=EUR&source=url)
+The plug-in is based on the [Python Client for Digikey API](https://github.com/peeter123/digikey-api)
+by [Peter Oostewechel](https://github.com/peeter123).
 
-# What does it do
-`digikey-api` is an [Digkey Part Search API](https://api-portal.digikey.com/node/8517) client for Python 3.6+. API response data is returned as Python objects that attempt to make it easy to get the data you want. Not all endpoints have been implemented.
+I'm not using the original project as a module because it pulls some rare dependencies.
 
-# Quickstart
-
-## Install
-```sh
-pip install digikey-api
-
-export DIGIKEY_CLIENT_ID="client_id"
-export DIGIKEY_CLIENT_SECRET="client_secret"
-export DIGIKEY_STORAGE_PATH="cache_dir"
-```
-
-# API V3
-## Register
-Register an app on the Digikey API portal: [Digi-Key API V3](https://developer.digikey.com/get_started). You will need 
-the client ID and the client secret to use the API. You will also need a Digi-Key account to authenticate, using the 
-Oauth2 process.
-
-When registering an app the OAuth Callback needs to be set to `https://localhost:8139/digikey_callback`.
-
-## Use [API V3]
-Python will automatically spawn a browser to allow you to authenticate using the Oauth2 process. After obtaining a token
-the library will cache the access token and use the refresh token to automatically refresh your credentials.
-
-You can test your application using the sandbox API, the data returned from a Sandbox API may not be complete, but the 
-structure of the Sandbox API response will be a representation of what to expect in Production.
-
-For valid responses make sure you use the client ID and secret for a [Production App](https://developer.digikey.com/documentation/organization)
-
-```python
-import os
-import digikey
-from digikey.v3.productinformation import KeywordSearchRequest
-
-os.environ['DIGIKEY_CLIENT_ID'] = 'client_id'
-os.environ['DIGIKEY_CLIENT_SECRET'] = 'client_secret'
-os.environ['DIGIKEY_CLIENT_SANDBOX'] = 'False'
-os.environ['DIGIKEY_STORAGE_PATH'] = 'cache_dir'
-
-# Query product number
-dkpn = '296-6501-1-ND'
-part = digikey.product_details(dkpn)
-
-# Search for parts 
-search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10)
-result = digikey.keyword_search(body=search_request)
-```
-
-## Top-level APIs
+The license is GPL v3 as the original work.
 
-#### Product Information
-All functions from the [PartSearch](https://developer.digikey.com/products/product-information/partsearch/) API have been implemented.
-* `digikey.keyword_search()`
-* `digikey.product_details()`
-* `digikey.digi_reel_pricing()`
-* `digikey.suggested_parts()`
-* `digikey.manufacturer_product_details()`
-
-#### Batch Product Details
-The one function from the [BatchProductDetailsAPI](https://developer.digikey.com/products/batch-productdetails/batchproductdetailsapi) API has been implemented.
-* `digikey.batch_product_details()`
-
-#### Order Support
-All functions from the [OrderDetails](https://developer.digikey.com/products/order-support/orderdetails/) API have been implemented.
-* `digikey.salesorder_history()`
-* `digikey.status_salesorder_id()`
-
-#### Barcode
-TODO
-
-## API Limits
-The API has a limited amount of requests you can make per time interval [Digikey Rate Limits](https://developer.digikey.com/documentation/shared-concepts#rate-limits). 
-
-It is possible to retrieve the number of max requests and current requests by passing an optional api_limits kwarg to an API function:
-```python
-api_limit = {}
-search_request = KeywordSearchRequest(keywords='CRCW080510K0FKEA', record_count=10)
-result = digikey.keyword_search(body=search_request, api_limits=api_limit)
-```
-
-The dict will be filled with the information returned from the API:
-```python
-{ 
-    'api_requests_limit': 1000, 
-    'api_requests_remaining': 139
-}
-```
-Sometimes the API does not return any rate limit data, the values will then be set to None.
-
-# API V2 [Deprecated]
-**NOTE: API V2 is not supported anymore by Digi-Key and you cannot register new applications**
-
-See API V3 above to use the new API.
-
-## Register
-Register an app on the Digikey API portal: [Digi-Key API V2](https://api-portal.digikey.com/start). You will need the client
-ID and the client secret to use the API. You will also need a Digi-Key account to authenticate, using the Oauth2 process.
-
-## Use
-Python will automatically spawn a browser to allow you to authenticate using the Oauth2 process. After obtaining a token
-the library will cache the access token and use the refresh token to automatically refresh your credentials.
-
-```python
-import os
-import digikey
-
-os.environ['DIGIKEY_CLIENT_ID'] = 'client_id'
-os.environ['DIGIKEY_CLIENT_SECRET'] = 'client_secret'
-os.environ['DIGIKEY_STORAGE_PATH'] = 'cache_dir'
+# Quickstart
 
-dkpn = '296-6501-1-ND'
-part = digikey.part(dkpn)
-print(part)
-# <Part mpn=NE555DR>
+- Register at Digi-Key. You need a valid user in order to register an application and in order to authenticate.
+- Go to the API portal: [Digi-Key API Solutions](https://developer.digikey.com/get_started)
+- Login to Digi-Key from the API portal
+- Create an [organization](https://developer.digikey.com/teams)
+- Choose the `Production Apps` operation
+- Create a production app
+  - Choose a `Production App name`
+  - Use `https://localhost:8139/digikey_callback` for the OAuth Callback. So you can authorize the use of the app.
+  - Give a description
+  - Enable the `Product Information` API
+  - Click `Add production app`
+- Now select your newly created `Production App`
+- In the `Credential` section enable the options to show the `Client ID` and `Client Secret`
+- Copy these values to a file named `config.txt` containing:
 
-print(part.manufacturer)
-# 'Texas Instruments'
 ```
-
-## Test
-```sh
-python -m pytest --cov=digikey --doctest-modules --ignore=setup.py
-python -m mypy digikey --ignore-missing-imports
+DIGIKEY_CLIENT_ID = Client_ID_Value_for_your_app
+DIGIKEY_CLIENT_SECRET = Client_Secret_Value_for_your_app
 ```
 
-## Top-level API
-* `digikey.search()`
-* `digikey.part()`
+- Create a folder `~/.config/kicost_digikey_api_v3`
+- Store the config.txt file
+- Now install the plug-in:
+  - Clone the git repo somewhere using `git clone https://github.com/set-soft/kicost-digikey-api-v3.git`
+  - Enter to `kicost-digikey-api-v3`
+  - Install it using `pip3 install -e .`
+- Now test the plug-in:
+  - run `python3 test_production.py`
+  - A browser window will pop-up asking to login to Digi-Key. Login.
+  - Choose the allow option to enable the token.
+  - Now you'll load a local page, allow it.
+  - Now the token is stored on disk and you won't need to confirm it for months.
+  - You should get the information for Digi-Key part 296-6501-6-ND
 
-## Data models
-* `digikey.models.KeywordSearchResult`
-* `digikey.models.Part`
diff --git a/debian/README.Debian b/debian/README.Debian
@@ -0,0 +1,8 @@
+kicost-digikey-api-v3 for Debian
+
+Please edit this to provide information specific to
+this kicost-digikey-api-v3 Debian package.
+
+    (Automatically generated by debmake Version 4.3.2)
+
+ -- Salvador E. Tropea <>  Mon, 21 Mar 2022 16:06:37 -0300
diff --git a/debian/changelog b/debian/changelog
@@ -0,0 +1,24 @@
+kicost-digikey-api-v3 (0.1.3-1) stable; urgency=medium
+
+  * Added support for Python 3.12
+
+ -- Salvador E. Tropea <salvador@inti.gob.ar>  Wed, 08 Nov 2023 08:58:30 -0300
+
+kicost-digikey-api-v3 (0.1.2-1) stable; urgency=medium
+
+  * Added option to exclude market place results
+  * Fixed problems when digi-key times out
+
+ -- Salvador E. Tropea <salvador@inti.gob.ar>  Thu, 06 Oct 2022 09:43:00 -0300
+
+kicost-digikey-api-v3 (0.1.1-1) stable; urgency=medium
+
+  * New upstream release
+
+ -- Salvador E. Tropea <salvador@inti.gob.ar>  Mon, 21 Mar 2022 16:55:01 -0300
+
+kicost-digikey-api-v3 (0.1.0-1) stable; urgency=low
+
+  * Initial release.
+
+ -- Salvador E. Tropea <stropea@inti.gob.ar>  Mon, 21 Mar 2022 16:06:37 -0300
diff --git a/debian/control b/debian/control
@@ -0,0 +1,15 @@
+Source: kicost-digikey-api-v3
+Section: electronics
+Priority: optional
+Maintainer: Salvador E. Tropea <stropea@inti.gob.ar>
+Build-Depends: debhelper-compat (= 12), dh-python, python3-all
+Standards-Version: 4.5.0
+Homepage: https://github.com/set-soft/kicost-digikey-api-v3/
+X-Python3-Version: >= 3.2
+
+Package: kicost-digikey-api-v3
+Architecture: all
+Multi-Arch: foreign
+Depends: ${misc:Depends}, ${python3:Depends}
+Description: Digi-Key API plug-in for KiCost
+ This package adds native support for Digi-Key to KiCost.