kospex 0.0.1__tar.gz

kospex-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Peter Freiberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kospex-0.0.1/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: kospex
+Version: 0.0.1
+Summary: The kospex CLI tool.
+Author-email: Peter Freiberg <peter.freiberg@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 Peter Freiberg
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://kospex.io
+Project-URL: Issues, https://github.com/kospex/kospex/issues
+Project-URL: Repository, https://github.com/kospex/kospex
+Keywords: analytics,git,code analytics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Click
+
+# kospex
+
+Kospex is a CLI which aims to _"look at the guts of your code"_ to help gain insights into your developers and technology landscape.
+It uses database structure from the excellent [Mergestat lite](https://github.com/mergestat/mergestat-lite) to model data from git repositories. 
+
+## Installation, setup and usage
+
+See the official [installation documentation](https://kospex.io/getting-started)
+
+
+## What is a kospex?
+
+We're aiming to [k]now your c[o]de by in[spe]cting the haruspe[x].
+From Wikipedia, _The Latin terms haruspex and haruspicina are from an archaic word, hīra = "entrails, intestines"_
+
+So we're going to help look at the "guts of your code" to gain an understanding of the applications, technology landscape (sprawl?) and developers.
+
+

kospex-0.0.1/README.md

@@ -0,0 +1,136 @@
+# kospex
+
+Kospex is a CLI which aims to _"look at the guts of your code"_ to help gain insights into your developers and technology landscape.
+It uses database structure from the excellent [Mergestat lite](https://github.com/mergestat/mergestat-lite) to model data from git repositories. 
+
+## Installation, setup and usage
+
+kospex is currently a collection of tools, bound together by python in a docker container. 
+It works by analysing cloned repositories on the filesystem. 
+
+### Step 0: Prepare (clone) the repositories you want to assess
+
+See section "Git code layout for running analysis" below. For simple "one off" analysis just clone some repo's into a directory as a starting point. 
+
+Ideally, a structure like \
+/BASE/GIT_SERVER/ORG/REPO
+
+### Step 1: Clone kospex
+
+> git clone https://github.com/kospex/kospex.git
+
+### Step 2: Install the python dependencies (and scc)
+
+**Optional but strongely recommended** - use a python virtual env. 
+
+> pip install -r requirements.txt
+
+Follow the instructions for installing [scc](https://github.com/boyter/scc)
+
+> export PATH=$PATH:$PWD
+
+Add this directory to your path, kospex toolkit is a collection on python executables.
+
+If you are ok to use the ~/code directory for cloned repos, then run: 
+> kospex init --default
+
+### Step 3: sync some data and play with some commands
+
+> kospex sync [GIT_REPO]
+>
+> kospex developers -repo [GIT_REPO]
+>
+> kospex tech-landscape -metadata
+
+You can also use the _kgit_ command to clone and sync a repo you have access to
+
+> kgit clone -sync -repo https://github.com/mergestat/mergestat-lite
+
+The above command will clone into the KOSPEX_CODE/GIT_SERVER/ORG/REPO structure
+
+## Git code layout for running analysis
+
+One option, if you're inspecting code on your own laptop is to use use your home directory. 
+
+~/kospex/ \
+We'll place config files and the kospex DB (Sqlite3) in here for sync'ed data \
+~/code/ \
+This should be your GIT_DATA_DIRECTORY with a structure like \
+GIT_SERVER/ORG/REPO \
+ \
+For example, in your ~/code it might look like: \
+github.com/kospex/kospex \
+github.com/mergestat/mergestat-lite
+
+This way we have a nice deterministic way of separating different orgs, potentially different instances (e.g. you have an on premise bitbucket and use GitHub.com) as well. 
+
+## Key Use Cases and features
+
+ - Identify technology landscape
+ - Identify active developers (e.g. who's had their code committer in the last 90 days)
+ - Identify key person or offboarding risk
+ - Identify potential complexity challenges (or conceptual integrity concerns)
+ - Aggregate repo metadata into a single database for easier and faster querying
+
+## Queries to try
+
+### sync a repo
+
+> kospex sync PATH/TO/GIT_REPO
+
+_Most functions require the data to be synced._ 
+
+### Show recent developers who've committed in X days
+
+List the active developers (90 days) in the given repo (sync required)
+> kospex developers -repo PATH/TO/REPO
+
+List the developers in the given repo_id (sync'ed data in the kospex DB)
+> kospex developers -repo_id=github.com˜ORG˜REPO
+
+use -days NUM for seen in the last # of days (e.g. 90 or 365)
+
+### Identify technology landscape
+
+List the overall tech stack, based on file extension, for all sync'ed repos
+> kospex tech-landscape
+
+List the overall tech stack for all sync'ed repos (using scc)
+> kospex tech-landscape -metadata
+
+List the overall tech stack for a repo (using scc)
+> kospex tech-landscape -repo PATH/TO/REPO
+
+List the tech stack in the given repo_id (sync'ed data in the kospex DB)
+> kospex tech-landscape -repo_id=github.com˜ORG˜REPO
+
+## Design principles
+
+- Precompute data where possible and useful
+- Flatten tables, data warehouse style, to enabled easier querying and slicing by git server, owner and repo
+- Be as agnostic to the git provider (i.e. GitHub, BitBucket, GitLab) for base use cases
+- Be mindful that "there is no perfect", only indicators
+- Separate cloning and pull updates from the analysis
+
+## Roadmap
+
+- Build out automated functional and regressions testing (Currently manual)
+- Build the ability to identify key person or offboarding risk
+- Improve use case documentation 
+- Provide a mechanism to better map author_emails to users
+
+## Data extractions and assumptions
+
+Most tables have a column, _repo_id, in the format of GIT_SERVER˜OWNER˜REPO  
+So for the repository https://github.com/kospex/kospex the _repo_id would be _github.com˜kospex˜kospex_
+
+Most queries use author_email from git to mean a "developer". This is not always accurate as GitHub 
+
+## What is a kospex?
+
+We're aiming to [k]now your c[o]de by in[spe]cting the haruspe[x].
+From Wikipedia, _The Latin terms haruspex and haruspicina are from an archaic word, hīra = "entrails, intestines"_
+
+So we're going to help look at the "guts of your code" to gain an understanding of the applications, technology landscape (sprawl?) and developers.
+
+

kospex-0.0.1/README.short.md

@@ -0,0 +1,18 @@
+# kospex
+
+Kospex is a CLI which aims to _"look at the guts of your code"_ to help gain insights into your developers and technology landscape.
+It uses database structure from the excellent [Mergestat lite](https://github.com/mergestat/mergestat-lite) to model data from git repositories. 
+
+## Installation, setup and usage
+
+See the official [installation documentation](https://kospex.io/getting-started)
+
+
+## What is a kospex?
+
+We're aiming to [k]now your c[o]de by in[spe]cting the haruspe[x].
+From Wikipedia, _The Latin terms haruspex and haruspicina are from an archaic word, hīra = "entrails, intestines"_
+
+So we're going to help look at the "guts of your code" to gain an understanding of the applications, technology landscape (sprawl?) and developers.
+
+

kospex-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=70.1.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kospex"
+version = "0.0.1"
+description = "The kospex CLI tool."
+authors = [
+    {name = "Peter Freiberg", email = "peter.freiberg@gmail.com"}
+]
+dependencies = [
+    "Click"
+]
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+readme = "README.short.md"
+keywords = ["analytics", "git", "code analytics"]
+
+#[project.scripts]
+#panopticas = "kospex:cli"
+
+[project.urls]
+Homepage = "https://kospex.io"
+Issues = "https://github.com/kospex/kospex/issues"
+Repository = "https://github.com/kospex/kospex"

kospex-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kospex-0.0.1/src/kospex.egg-info/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.1
+Name: kospex
+Version: 0.0.1
+Summary: The kospex CLI tool.
+Author-email: Peter Freiberg <peter.freiberg@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2023 Peter Freiberg
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://kospex.io
+Project-URL: Issues, https://github.com/kospex/kospex/issues
+Project-URL: Repository, https://github.com/kospex/kospex
+Keywords: analytics,git,code analytics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Click
+
+# kospex
+
+Kospex is a CLI which aims to _"look at the guts of your code"_ to help gain insights into your developers and technology landscape.
+It uses database structure from the excellent [Mergestat lite](https://github.com/mergestat/mergestat-lite) to model data from git repositories. 
+
+## Installation, setup and usage
+
+See the official [installation documentation](https://kospex.io/getting-started)
+
+
+## What is a kospex?
+
+We're aiming to [k]now your c[o]de by in[spe]cting the haruspe[x].
+From Wikipedia, _The Latin terms haruspex and haruspicina are from an archaic word, hīra = "entrails, intestines"_
+
+So we're going to help look at the "guts of your code" to gain an understanding of the applications, technology landscape (sprawl?) and developers.
+
+

kospex-0.0.1/src/kospex.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+README.short.md
+pyproject.toml
+src/kospex.egg-info/PKG-INFO
+src/kospex.egg-info/SOURCES.txt
+src/kospex.egg-info/dependency_links.txt
+src/kospex.egg-info/requires.txt
+src/kospex.egg-info/top_level.txt
+tests/test_capitalise.py

kospex-0.0.1/src/kospex.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kospex-0.0.1/src/kospex.egg-info/requires.txt

@@ -0,0 +1 @@
+Click

kospex-0.0.1/src/kospex.egg-info/top_level.txt

@@ -0,0 +1 @@
+

kospex-0.0.1/tests/test_capitalise.py

@@ -0,0 +1,5 @@
+# test_capitalize.py
+
+from kospex_core import Kospex
+import pytest
+