Minor tweaks in README, others

LCSC-API.md

@@ -1,10 +1,11 @@
 # LCSC API
 
-- to get a product page based on LCSC number use GET request on
+1. To get a product page based on LCSC number, use GET request on
   `https://lcsc.com/api/global/additional/search?q=<part_number>`. You get a
   JSON with URL of the product.
-- to get a product options based on LSCS number use POST request to
+2. To get a product options based on LSCS number, use POST request to
   `https://lcsc.com/api/products/search` with data
-  `current_page=1&in_stock=false&is_RoHS=false&show_icon=false&search_content=<part_number>`
+  `current_page=1&in_stock=false&is_RoHS=false&show_icon=false&search_content=<part_number>`.
   You have to include CSRF token and cookies. Both you can get from the category
-  page (e.g., `https://lcsc.com/products/Pre-ordered-Products_11171.html`)
+  page (e.g., `https://lcsc.com/products/Pre-ordered-Products_11171.html`).
+

README.md

@@ -1,29 +1,31 @@
 ![Logo](web/public/favicon.svg)
 
-# JLC PCB SMD Assembly Component Catalogue
+# JLCPCB SMD Assembly Component Catalogue
 
-A better tool to browse the components offered by the [JLC PCB SMT Assembly
+A better tool to browse the components offered by the [JLCPCB SMT Assembly
 Service](https://jlcpcb.com/smt-assembly).
 
 ## How To Use It?
 
 Just visit: [https://yaqwsx.github.io/jlcparts/](https://yaqwsx.github.io/jlcparts/)
 
+The site and parts cache is hosted on GitHub Pages.
+
 ## Why?
 
-Probably all of us love JLC PCB SMT assembly service. It is easy to use, cheap
+Probably all of us love JLCPCB SMT assembly service. It is easy to use, cheap
 and fast. However, you can use only components from [their
 catalogue](https://jlcpcb.com/parts). This is not as bad, since the library is
-quite broad. However, the library UI sucks. You can only browse the categories,
-do full-text search. You cannot do parametric search nor sort by property.
+quite broad. However, the library UI sucks. You can only browse the categories and do full-text searches. You cannot do parametric search nor sort by property.
+
 That's why I created a simple page which presents the catalogue in much nicer
 form. You can:
 - do full-text search
 - browse categories
 - parametric search
 - sort by any component attribute
 - sort by price based on quantity
-- easily access datasheet and LCSC product page.
+- easily access datasheet and LCSC product page
 
 ## Do You Enjoy It? Does It Make Your Life Easier?
 
@@ -32,30 +34,30 @@ form. You can:
 Support on Ko-Fi allows me to develop such tools as this one and perform
 hardware-related experiments.
 
-## How Does It Look Like?
+## What Does It Look Like?
 
-Title page
+### Title Page
 
 ![Preview 1](https://user-images.githubusercontent.com/1590880/93708766-32ab0d80-fb39-11ea-8365-da2ca1b13d8b.jpg)
 
-Property filter
+### Property Filter
 
 ![Preview 2](https://user-images.githubusercontent.com/1590880/93708599-e01d2180-fb37-11ea-96b6-5d5eb4e0f285.jpg)
 
-Component detail
+### Component Detail
 
 ![Preview 3](https://user-images.githubusercontent.com/1590880/93708601-e0b5b800-fb37-11ea-84ed-6ba73f07911d.jpg)
 
 
 ## How Does It Work?
 
-The page has no backend so it can be easily hosted on GitHub Pages. Therefore,
-Travis CI download XLS spreadsheet from the JLC PCB page, a Python script
-process it and it generates per-category JSON file with components.
+The page has no backend so it can be easily hosted on GitHub Pages.
+Travis CI downloads the XLSX spreadsheet from the JLCPCB page, a Python script
+processes it, and it generates a per-category JSON file with components.
 
 The frontend uses IndexedDB in the browser to store the component library and
-perform queries on it. Therefore, before the first use, you have to download the
-component library and it can take a while. Then, all the queries are performed
+perform queries on it. Therefore, before the first use, the page downloads the
+component library (it can take a while). Then, all the queries are performed
 locally.
 
 ## Development
@@ -64,40 +66,43 @@ To get started with developing the frontend, you will need NodeJS & Python 3.
 
 Set up the Python portion of the program by running:
 
-```
+```bash
 $ virtualenv venv
 $ source venv/bin/activate
 $ pip install -e .
 ```
 
-Then to download the cached parts list and process it, run:
+Then to download the cached parts list (from the GH Pages site, generated via GH Actions) and process it, run:
 
-```
+```bash
 $ wget https://yaqwsx.github.io/jlcparts/data/cache.zip https://yaqwsx.github.io/jlcparts/data/cache.z0{1..8}
 $ 7z x cache.zip
 $ mkdir -p web/public/data/
 $ jlcparts buildtables --jobs 0 --ignoreoldstock 30 cache.sqlite3 web/public/data
 ```
 
+To understand how the GH Actions generate the cache zip file, refer to the
+[update_components.yaml workflow](.github/workflows/update_components.yaml).
+
 To launch the frontend web server, run:
 
-```
+```bash
 $ cd web
 $ npm install
 $ npm start
 ```
 
-## The Page Is Broken!
+## Reporting Issues
 
-Feel free to open an issue on GitHub.
+If the page is broken, feel free to open an issue on GitHub.
 
-## You Might Also Be Interested
+## Related Projects
 
 - [KiKit](https://github.com/yaqwsx/KiKit): a tool for automatic panelization of
   KiCAD PCBs. It can also perform fully automatic export of manufacturing data
-  for JLC PCB assembly - read [the
+  for JLCPCB assembly - read [the
   documentation](https://github.com/yaqwsx/KiKit/blob/master/doc/fabrication/jlcpcb.md)
-  or produce a solder-paste stencil for populating components missing at JLC PCB - read [the
+  or produce a solder-paste stencil for populating components missing at JLCPCB - read [the
   documentation](https://github.com/yaqwsx/KiKit/blob/master/doc/stencil.md).
 - [PcbDraw](https://github.com/yaqwsx/PcbDraw): a tool for making nice schematic
   drawings of your boards and population manuals.

jlcparts/datatables.py

@@ -137,6 +137,22 @@ def normalizeAttribute(key, value):
     assert isinstance(value, dict)
     return key, value
 
+def normalizeCapitalization(key):
+    """
+    Given a category name, normalize capitalization. We turn everything
+    lowercase, but some known substring (such as MOQ or MHz) replace back to the
+    correct capitalization
+    """
+    key = key.lower()
+    key = key[0].upper() + key[1:]
+
+    CAPITALIZATIONS = [
+        "MHz", "GHz", "Hz", "MOQ"
+    ]
+    for capt in CAPITALIZATIONS:
+        key = key.replace(capt.lower(), capt)
+    return key
+
 def normalizeAttributeKey(key):
     """
     Takes a name of attribute and its value and returns a normalized key
@@ -170,7 +186,7 @@ def normalizeAttributeKey(key):
         key = "Lifetime @ Temperature"
     if key.startswith("Q @ Freq"):
         key = "Q @ Frequency"
-    return key
+    return normalizeCapitalization(key)
 
 def pullExtraAttributes(component):
     """
@@ -285,7 +301,7 @@ class MapCategoryParams:
 
 
 def _map_category(val: MapCategoryParams):
-    # Sometimes, JLC PCB doesn't fill in the category names. Ignore such
+    # Sometimes, JLCPCB doesn't fill in the category names. Ignore such
     # components.
     if val.catName.strip() == "":
         return None

jlcparts/ui.py

@@ -22,7 +22,7 @@ def fetchLcscData(lcsc):
 def getLibrary(source, db, age, limit):
     """
     Download library inside OUTPUT (JSON format) based on SOURCE (csv table
-    provided by JLC PCB).
+    provided by JLCPCB).
 
     You can specify previously downloaded library as a cache to save requests to
     fetch LCSC extra data.
@@ -111,7 +111,7 @@ def fetchDetails(lcsc_code):
     help="Be verbose")
 def fetchTable(filename, verbose):
     """
-    Fetch JLC PCB component table
+    Fetch JLCPCB component table
     """
     from .jlcpcb import pullComponentTable
 

setup.py

@@ -2,7 +2,6 @@
 
 import setuptools
 
-
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
@@ -11,10 +10,10 @@
     version="0.1.0",
     author="Jan Mrázek",
     author_email="email@honzamrazek.cz",
-    description="Better view of JLC PCB parts",
+    description="Better view of JLCPCB parts",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/RoboticsBrno/JLCPCB-Parts",
+    url="https://github.com/yaqwsx/jlcparts",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
@@ -36,4 +35,4 @@
             "jlcparts=jlcparts.ui:cli"
         ],
     }
-)
+)

web/public/index.html

@@ -15,8 +15,8 @@
     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta
-      name="JLC PCB SMD Assembly Component Catalogue"
-      content="Parametric search for components offered by JLC PCB SMD assembly service."
+      name="JLCPCB SMD Assembly Component Catalogue"
+      content="Parametric search for components offered by JLCPCB SMD assembly service."
     />
 
     <link rel="apple-touch-icon" sizes="180x180" href="%PUBLIC_URL%/apple-touch-icon.png">

web/src/app.js

@@ -25,10 +25,10 @@ function Header(props) {
       <img src="./favicon.svg" alt="" className="block flex-none mr-4 h-auto"/>
       <div className="flex-1">
         <h1 className="text-4xl font-bold">
-          JLC PCB SMD Assembly Component Catalogue
+          JLCPCB SMD Assembly Component Catalogue
         </h1>
         <p>
-          Parametric search for components offered by <a href="https://jlcpcb.com" className="underline text-blue-600">JLC PCB</a> SMD assembly service.
+          Parametric search for components offered by <a href="https://jlcpcb.com" className="underline text-blue-600">JLCPCB</a> SMD assembly service.
         </p>
         <p>
           Read more at project's <a className="underline text-blue-500 hover:text-blue-800" href="https://github.com/yaqwsx/jlcparts">GitHub page</a>.