add changelog and update workflow

Author: nsnguyen

.github/workflows/python-publish.yml

@@ -29,11 +29,9 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build
+        pip install setuptools wheel twine
     - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: make release

CHANGELOG.md

@@ -0,0 +1,20 @@
+.PHONY: clean-pyc clean-build test
+
+clean: clean-build clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr src/*.egg-info
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+build: clean
+	python setup.py sdist bdist_wheel
+
+release: build
+	twine check dist/*
+	twine upload dist/*

Makefile

@@ -2,15 +2,9 @@
 
 dotenv-vault-python allows your app to sync the `.env` file to the cloud. This means that you can work anywhere, in any machine, and in any cloud infrastructure with cofidence.
 
+- [Getting Started](#getting-started)
+
 ## Getting Started
-```
+```shell
 pip install python-dotenv-vault --no-cache-dir
 ```
-
-
-## Push to pipy
-```
-pip install twine
-python setup.py publish
-# enter username and password
-```

README.md

@@ -7,18 +7,20 @@
 with open(os.path.join(dir, "src/dotenv", "__version__.py"), "r") as f:
     exec(f.read(), src)
 
-with open("README.md", "r") as f:
-    readme = f.read()
+def read_files(files):
+    data = []
+    for file in files:
+        with open(file, encoding='utf-8') as f:
+            data.append(f.read())
+    return "\n".join(data)
 
-# 'setup.py publish' shortcut.
-if sys.argv[-1] == "publish":
-    os.system("python setup.py sdist")
-    os.system(f"twine upload dist/python-dotenv-vault-{src['__version__']}.tar.gz")
-    sys.exit()
+readme = read_files(['README.md', 'CHANGELOG.md'])
 
 setup(
     name='python-dotenv-vault',
     description=src['__description__'],
+    long_description=readme,
+    long_description_content_type='text/markdown',
     version=src['__version__'],
     license=src['__license__'],
     author=src['__author__'],

setup.py

@@ -7,7 +7,7 @@
 __title__ = "python-dotenv-vault"
 __description__ = "Syncing your .env to the cloud."
 __url__ = "https://github.com/dotenv-org/dotenv-vault-python"
-__version__ = "0.0.5"
+__version__ = "0.0.6"
 __author__ = "dotenv"
 __author_email__ = "[email protected]"
 __license__ = "MIT"

src/dotenv/__version__.py

@@ -2,5 +2,6 @@
 from typing import Optional
 
 
+
 def load_dotenv():
     print('loading dotenv-vault.')