From 663fbcf83c36c6b9e5732495088fa3cdf8035c11 Mon Sep 17 00:00:00 2001
From: David Hendriks <davidhendriks93@gmail.com>
Date: Wed, 9 Dec 2020 16:53:11 +0000
Subject: [PATCH] added the readme again. need to update it but that will be
fixed soon
---
README | 0
README.md | 9 +++++++++
setup.py | 27 +++++++--------------------
3 files changed, 16 insertions(+), 20 deletions(-)
delete mode 100644 README
diff --git a/README b/README
deleted file mode 100644
index e69de29bb..000000000
diff --git a/README.md b/README.md
index 2f8da3784..ab8deb673 100644
--- a/README.md
+++ b/README.md
@@ -51,3 +51,12 @@ Also: I figured that having binaryc output the log like "<LOG HEADER> t=10e4 ...
See examples/ dir for some working examples
When you try to `import binary_c_python_api` and python complains about it not existing, but you are sure that you correctly included the necessary pythonpaths, then you probably need to rebuild the package.
+
+
+
+FAQ:
+--------------------
+
+
+pip install failed:
+if pip installation results in `No files/directories in /tmp/pip-1ckzg0p9-build/pip-egg-info (from PKG-INFO)`, try running it verbose (`-v`) to see what is actually going wrong.
diff --git a/setup.py b/setup.py
index 709d7b7b9..9957483e0 100644
--- a/setup.py
+++ b/setup.py
@@ -16,16 +16,10 @@ import distutils.command.build
# Functions
def readme():
"""Opens readme file and returns content"""
- with open("README") as file:
+ with open("README.md") as file:
return file.read()
-# def readme_rst():
-# """Opens readme file and returns contents converted to rst"""
-# with open("README.md") as file:
-# return md_to_rst.convertMarkdownToRst(file.read())
-
-
def license():
"""Opens license file and returns the content"""
with open("LICENSE.md") as file:
@@ -230,29 +224,22 @@ class CustomBuildCommand(distutils.command.build.build):
def run(self):
# execute_make()
- # Run the original build command
# print(super().run())
+ # Run the original build command
distutils.command.build.build.run(self)
-
-# It is tested and designed to work for versions {}, we can't guarantee proper functioning for other versions
-
-# If you want to use a different version of binary_c, download and install a different version of this package
-
-
setup(
name="binarycpython",
- version="0.2.2",
- description="""
-This is a python API for binary_c (versions {}) by David Hendriks, Rob Izzard and collaborators. Based on the initial set up by Jeff andrews.
-""".format(
+ version="0.2.4",
+ description="""This is a python API for binary_c (versions {}) by David Hendriks, Rob Izzard and collaborators. Based on the initial set up by Jeff andrews.""".format(
",".join(REQUIRED_BINARY_C_VERSIONS),
",".join(REQUIRED_BINARY_C_VERSIONS),
),
author="David Hendriks",
author_email="davidhendriks93@gmail.com",
- # long_description=readme(),
- long_description="hello",
+ long_description=readme(),
+ # long_description="hello",
+ long_description_content_type='text/markdown',
url="https://gitlab.eps.surrey.ac.uk/ri0005/binary_c-python",
license="gpl",
keywords=[
--
GitLab