commit c9d5db815249730a3ee61fa153c3f782c2e2e2cb
parent e47dcc88ce7aa8646e4784d6b558dcc4b1bcb1d3
Author: Paco Esteban <paco@e1e0.net>
Date: Mon, 5 Apr 2021 13:32:41 +0200
Add License and Readme
Diffstat:
| A | LICENSE | | | 13 | +++++++++++++ |
| A | README | | | 29 | +++++++++++++++++++++++++++++ |
2 files changed, 42 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2021 Paco Esteban <paco@e1e0.net>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README b/README
@@ -0,0 +1,29 @@
+PartsDB is a simple, "it works for me™" solution for electronics parts
+inventory.
+
+I created it in anger after I had problems with Partkeepr for the
+gazillionth time.
+
+It's a nasty Python3 cli tool (no, seriously, it's terrible) that
+accesses an sqlite3 database.
+
+Features:
+
+* It does what I need, and no more:
+ * add/delete parts
+ * list parts from a category
+ * search parts (really basic)
+ * modify stock
+* All is stored on a sqlite3 file.
+* The `add` function calls Octopart to get all the date, so I don't have
+ to type like a monkey.
+* There's a `get` command that shows all the details of a part, and can
+ call yout pdf viewer to open the datasheet if there is one.
+* It can export the whole inventory to HTML. Here's mine, for instance:
+ https://e1e0.net/partsdb/
+
+
+If you want to use it, you'll need an Octopart API key. Then put it on
+the environemnt with the name `OCTOPART_TOKEN`.
+
+I couldn't bother to create a man page. Take a look at `--help`.
