Update header and footer in README.md and add MIT License (#28)

* Add files via upload

* Update README.md

* Update pyproject.toml

* Rename LICENSE.txt to LICENSE

* Update README.md

* Update pyproject.toml

* Update slack_utils.py

Author: gsheni

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 DataCebo
+
+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.

README.md

@@ -3,7 +3,19 @@
 <p align="center">
     <i>This repository is part of <a href="https://sdv.dev">The Synthetic Data Vault Project</a>, a project from <a href="https://datacebo.com">DataCebo</a>.</i>
 </p>
-<div align="left">
+
+[![Dev Status](https://img.shields.io/badge/Dev%20Status-5%20--%20Production%2fStable-green)](https://pypi.org/search/?c=Development+Status+%3A%3A+5+-+Production%2FStable)
+[![Slack](https://img.shields.io/badge/Slack-Join%20now!-36C5F0?logo=slack)](https://bit.ly/sdv-slack-invite)
+
+<div align="center">
+  <a href="https://datacebo.com">
+  <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/sdv-dev/SDV/blob/stable/docs/images/datacebo-logo-dark-mode.png">
+      <img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/datacebo-logo.png"></img>
+  </picture></a>
+</div>
+<br/>
+</div>
 
 # GitMetrics
 
@@ -79,14 +91,16 @@ GitMetrics is capable of reading and writing results in Google Spreadsheets. The
 
 ---
 
-<div align="center">
-  <a href="https://datacebo.com"><picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://github.com/sdv-dev/SDV/blob/stable/docs/images/datacebo-logo-dark-mode.png">
-      <img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/datacebo-logo.png"></img>
-  </picture></a>
-</div>
-<br/>
+<div align="left">
 <br/>
+<p align="center">
+<a href="https://github.com/sdv-dev/SDV">
+<img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/SDV-logo.png"></img>
+</a>
+</p>
+</div>
+
+</div>
 
 [The Synthetic Data Vault Project](https://sdv.dev) was first created at MIT's [Data to AI Lab](
 https://dai.lids.mit.edu/) in 2016. After 4 years of research and traction with enterprise, we
@@ -98,4 +112,4 @@ data, including:
 * 🔄 Data discovery & transformation. Reverse the transforms to reproduce realistic data.
 * 🧠 Multiple machine learning models -- ranging from Copulas to Deep Learning -- to create tabular,
   multi table and time series data.
-* 📊 Measuring quality and privacy of synthetic data, and comparing different synthetic data
+* 📊 Measuring quality and privacy of synthetic data, and comparing different synthetic data

gitmetrics/slack_utils.py

@@ -5,7 +5,7 @@
 
 from slack_sdk import WebClient
 
-GITHUB_URL_PREFIX = 'https://github.com/datacebo/gitmetrics/actions/runs/'
+GITHUB_URL_PREFIX = 'https://github.com/sdv-dev/gitmetrics/actions/runs/'
 DEFAULT_SLACK_CHANNEL = 'sdv-alerts-debug'
 
 

pyproject.toml

@@ -11,6 +11,16 @@ authors = [
     { name = "DataCebo", email = "[email protected]" }
 ]
 requires-python = ">=3.13"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'Natural Language :: English',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.13',
+    "Topic :: Scientific/Engineering",
+]
 dependencies = [
     "pandas >= 2.2.3",
     "tqdm",
@@ -23,7 +33,7 @@ dependencies = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/datacebo/gitmetrics"
+Homepage = "https://github.com/sdv-dev/gitmetrics"
 
 [project.scripts]
 gitmetrics = "gitmetrics.__main__:main"