about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2021-08-14 22:11:10 +0530
committerAndinus <andinus@nand.sh>2021-08-14 22:11:10 +0530
commit8a6b84374a42c4e28f25eaf0979dc4ccc7630549 (patch)
treee5581851c05a066e5faeec23e078fefad564e845
downloadtaurus-8a6b84374a42c4e28f25eaf0979dc4ccc7630549.tar.gz
Initial Commit
-rw-r--r--.gitignore2
-rw-r--r--LICENSE13
-rw-r--r--META6.json21
-rw-r--r--README.org72
-rw-r--r--bin/taurus3
5 files changed, 111 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..640f8ae
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+.precomp
+sdist/
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e51df07
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2021, Andinus <andinus@nand.sh>
+
+Permission to use, copy, modify, and/or 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/META6.json b/META6.json
new file mode 100644
index 0000000..f414964
--- /dev/null
+++ b/META6.json
@@ -0,0 +1,21 @@
+{
+    "name" : "taurus",
+    "auth" : "zef:andinus",
+    "version" : "0.1.0",
+    "description" : "Taurus parses Call logs",
+    "authors" : [ "Andinus <andinus@nand.sh>" ],
+    "license" : "ISC",
+    "perl" : "6.d",
+    "provides" : {
+        "Taurus::CLI" : "lib/Taurus/CLI.rakumod"
+    },
+    "depends" : [
+        "CSV::Parser",
+        "Terminal::Spinners",
+        "Text::Table::Simple"
+    ],
+    "tags": [
+        "Taurus", "Call logs", "Call"
+    ],
+    "source-url" : "https://git.tilde.institute/andinus/taurus"
+}
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..ed00e54
--- /dev/null
+++ b/README.org
@@ -0,0 +1,72 @@
+#+title: Taurus
+#+subtitle: Taurus parses Call logs
+#+export_file_name: index
+#+setupfile: ~/.emacs.d/org-templates/projects.org
+
+| Website         | https://andinus.nand.sh/taurus             |
+| Source          | https://git.tilde.institute/andinus/taurus |
+| GitHub (mirror) | https://github.com/andinus/taurus          |
+
+* Installation
+
+Taurus is released to ~fez~, you can get it from there or install it from
+source. In any case, ~zef~ is required to install the distribution.
+
+You can run Taurus without ~zef~. Just run ~raku -Ilib bin/taurus~ from
+within the source directory.
+
+** Release
+
+1. Run ~zef install taurus~.
+
+Taurus should be installed, try running ~taurus --version~ to confirm.
+
+** From Source
+
+You can either download the release archive generated by cgit/GitHub or
+clone the project if you have ~git~ installed.
+
+*** Without ~git~
+
+1. Download the release:
+   - https://git.tilde.institute/andinus/taurus
+   - https://github.com/andinus/taurus/releases
+2. Extract the file.
+3. Run ~zef install .~ in source directory.
+
+*** With ~git~
+
+All commits will be signed by my [[https://andinus.nand.sh/static/D9AE4AEEE1F1B3598E81D9DFB67D55D482A799FD.asc][PGP Key]].
+
+#+begin_src sh
+# Clone the project.
+git clone https://git.tilde.institute/andinus/taurus
+cd taurus
+
+# Install taurus.
+zef install .
+#+end_src
+
+* Documentation
+
+Taurus parses Call logs exported by [[https://f-droid.org/en/packages/opencontacts.open.com.opencontacts/][OpenContacts]]. Get the application
+from F-Droid and export the call logs by selecting /More/, then /Export
+call log/ from the three dot menu on top right.
+
+** Implementation
+
+It parses the exported log file line by line, stores them & presents an
+interface.
+
+** Options
+
+*** log
+
+Exported log file.
+
+*** digits
+
+Number of significant digits in phone numbers. Default is set to 10. If
+the number of digits is less than significant digits then the number is
+picked, if it's more then the initial extra digits are discarded
+(Country Code, etc.).
diff --git a/bin/taurus b/bin/taurus
new file mode 100644
index 0000000..2b1b838
--- /dev/null
+++ b/bin/taurus
@@ -0,0 +1,3 @@
+#!/usr/bin/env raku
+
+use Taurus::CLI;