From 2ccca30c33c2f9348565ab954816ab1b0b5c4943 Mon Sep 17 00:00:00 2001
From: Frank Sauerburger <frank@sauerburger.com>
Date: Fri, 3 Nov 2017 11:09:57 +0100
Subject: [PATCH] Add PyPI setup file
Add metadata file for PyPI and specify readme file.
---
README.md | 8 +++++++-
setup.cfg | 2 ++
setup.py | 1 +
3 files changed, 10 insertions(+), 1 deletion(-)
create mode 100644 setup.cfg
diff --git a/README.md b/README.md
index 3907087..e9e110e 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,13 @@ This ensures that the code snippets work as intended.
# Installation [](https://srv.sauerburger.com/esel/doxec/commits/master)
-You can simply clone the repository and run the setup script to get doxec.
+You can install the package using pip
+
+```bash
+$ pip install doxec
+```
+
+or you can clone the repository and run the setup script to get doxec.
<!-- console
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..b88034e
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md
diff --git a/setup.py b/setup.py
index 46ba73e..bbad803 100644
--- a/setup.py
+++ b/setup.py
@@ -14,6 +14,7 @@ setup(
packages=['doxec'],
scripts=['bin/doxec'],
test_suite='doxec.tests',
+ url="https://gitlab.sauerburger.com/frank/doxec",
classifiers=[
"Development Status :: 3 - Alpha",
"Environment :: Console",
--
GitLab