Commit 663fbcf8 authored by David Hendriks's avatar David Hendriks
Browse files

added the readme again. need to update it but that will be fixed soon

parent 8040f3b7

README

deleted100644 → 0
+0 −0

Empty file deleted.

README.md

+9 −0
Original line number Diff line number Diff line
@@ -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.

setup.py

+7 −20
Original line number Diff line number Diff line
@@ -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=[