From 73c230b2504243201476004a98dfc8e6eb55e08a Mon Sep 17 00:00:00 2001
From: Sam <greydanus@users.noreply.github.com>
Date: Mon, 20 May 2024 11:12:45 -0700
Subject: [PATCH] Repo is now on PyPl

---
 README.md      |  9 ++++++++-
 pypl_notes.md  | 15 +++++++++++++++
 pyproject.toml |  4 ++++
 3 files changed, 27 insertions(+), 1 deletion(-)
 create mode 100644 pypl_notes.md

diff --git a/README.md b/README.md
index 319afeb..aa18648 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ Installing with `pip`
 --------
 
 ``` shell
-python -m pip install git+https://github.com/greydanus/mnist1d.git@master
+pip install mnist1d
 ```
 
 This allows you to build the default dataset locally:
@@ -52,6 +52,13 @@ x,y,t = data['x'], data['y'], data['t']
 If you want to play around with this, see [notebooks/mnist1d-pip.ipynb](https://github.com/greydanus/mnist1d/blob/master/notebooks/mnist1d-pip.ipynb).
 
 
+Alternatively, you can always `pip install` via the GitHub repo:
+
+``` shell
+python -m pip install git+https://github.com/greydanus/mnist1d.git@master
+```
+
+
 Comparing MNIST and MNIST-1D
 --------
 
diff --git a/pypl_notes.md b/pypl_notes.md
new file mode 100644
index 0000000..79496a3
--- /dev/null
+++ b/pypl_notes.md
@@ -0,0 +1,15 @@
+# SJG Notes for PYPL uploads:
+
+
+* `git tag v0.0.1`
+* `git push origin v0.0.1`
+* (commit)
+* `python3 -m build`
+* Upload w/`twine` (Test)
+  * `python3 -m twine upload --repository testpypi dist/*`
+  * `python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps mnist1d`
+  * View on `https://test.pypi.org/project/mnist1d/`
+* Upload w/`twine` (Main)
+  * `python3 -m twine upload dist/*`
+  * `python3 -m pip install mnist1d`
+  * View on `https://pypi.org/project/mnist1d/`
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 38a69df..fba4f0c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -43,6 +43,10 @@ all = ["torch","notebook"]
 [tool.setuptools]
 packages = ["mnist1d"]
 
+[tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "no-local-version"
+
 # [tool.setuptools.packages.find]
 # where = ["mnist1d"]