Add documentation to pypi

[SvetaMemphis]

Add documentation to pypi

[Adarsh-jaiss]

• please review pr #46 , I have committed these changes :)

[SvetaMemphis]

We need to add to our setup.py long_description attribute.
That can be a reference to the description file (examples here) or to add a text in the file - take numpy for example.

The text should be memphis decription as it is written in our README from line 26.

[Adarsh-jaiss]

-- so, in simple terms, we need to add multi line comments in setup.py file!

[SvetaMemphis]

@Adarsh-jaiss Yes, you're right! And there is always the option to refer to a file and then manage the changes in this file.
We will appreciate a contribution on this one, so our PyPi users will see the documentation as well!

[Adarsh-jaiss]

-- can you please explain , the steps for fixing this issue because I am little confused :)

[SvetaMemphis]

Sure!
In our PyPi repo there is no documentation. We want our users to see our python-sdk documentation on this page. In order to do so we need to update setup.py according to PyPa (Python Packaging Authority) requirements, which appear here.
To do so we need to update long_description field.
There are 2 ways to do so:

1. To refer to README file. If we use this option we should pay attention to referring to a file that will be displayed properly on PyPI, you can find the requirements in the link to PyPa.
2. To add a multiline comment as you mentioned and then refer to it in the long_description the same way as numpy did.

I always prefer to use the first way and manage a dedicated file for this purpose.

You can find the documentation that needs the adaptation here.

I will be happy to answer further questions. 💫

[Adarsh-jaiss]

• okay so the thing is i need to update this code syntax in and link the file to it!

from setuptools import setup

# read the contents of your README file
from pathlib import Path
this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
    name='an_example_package',
    # other arguments omitted
    long_description=long_description,
    long_description_content_type='text/markdown'
)

and kindly review this :

from setuptools import setup

# read the contents of your README file
from pathlib import Path
this_directory = Path(__memphis.py/README.md__).parent
long_description = (this_directory / "README.md").read_text()

setup(
    name='pypi',
    # other arguments omitted
    long_description=long_description,
    long_description_content_type='text/markdown'
)

-- And here ,please choose one that i need to add in long_description_content type

1.  long_description_content_type =  text/markdown; charset=UTF-8; variant=GFM

2.   long_description_content_type='text/markdown'

other than that please tell me what to write in long_description

and do i have to replace and add this whole syntax from file or i have to just add this syntax to that file ?

[SvetaMemphis]

Thanks for the reply, I think adding these 2 lines will work, this file and README are in the same directory,

setup(
    long_description = file: README.md
    long_description_content_type = text/markdown; charset=UTF-8; variant=GF
)

We just need to ensure that our README.md is written according to PyPa requirements.

you can open a new branch and create a PR :)

[SvetaMemphis]

Also here is a good example:
The Repo is here
And that's how it looks in PyPi

[SvetaMemphis]

Thank you @Adarsh-jaiss for the contribution, it looks good!
Your PR will be merged during the next day and will be released on our next release.
Great having you with us :)

[Adarsh-jaiss]

-- Thank you so much @SvetaMemphis for helping me in this whole contribution journey

-- I am in love with the Memphis community and I am looking forward for more such contributions

[idanasulin2706]

PR approved and will be released on the coming version, thanks a lot @Adarsh-jaiss you are rocking