Added instructions on how to upload to PyPi

* Added a docs/upload-to-pypi.md file * Added the setup.cfg file * Updated setup.py: Added version, license and url meta information
composer-version-manager · Mar 1, 2021 · 4392aff · 4392aff
1 parent fb85dd6
commit 4392aff
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/docs/upload-to-pypi.md b/docs/upload-to-pypi.md
@@ -0,0 +1,24 @@
+# Table of contents
+
+* [Table of contents](#table-of-contents)
+  * [Pre-req](#pre-req)
+  * [Upload process](#upload-process)
+
+## Pre-req
+
+* Register an account with (pypy.org)[https://pypi.org]
+* Install twine with `pip install twine`
+
+## Upload process
+
+* Build your release candidate with:
+
+```bash
+python setup.py sdist
+```
+
+* Upload the package with
+
+```bash
+twine upload dist/*
+```
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,4 @@
+# Inside of setup.cfg
+[metadata]
+description-file = README.md
+
diff --git a/setup.py b/setup.py
@@ -3,6 +3,9 @@
 setup(
     name='Composer Version Manager',
     packages=find_packages(),
+    version='1.0.6',
+    license='MIT',
+    url = 'https://github.com/composer-version-manager/cvm',
     entry_points={
         'console_scripts': [
             'cvm=cvm.cli:main',