Research and Implement PyPI Requirements

[ichabod801]

I know I need setup.py and some dunder module attributes, but figure out exactly what I need.

[ichabod801]

From realpython.com:

• Check the name (done)
• setup.py file
  • import setup from setuptools
  • Call setup with a bunch of parameters.
  • name: the name of the project
  • version: The version string.
  • packages: A list of package names (list of str).
  • There are docs for the rest.
• README: How to install and use (long_description parameter to setup).
• MANIFEST.in: If you want to add other non-source-code files to the project.
  • Also, include_package_data = True when calling setup.
• Create an account on PyPI (and maybe TestPyPI)
• Upload the package using twine (pip install twine).
  • Build the package. They use python setup.py sdist bdist_wheel. This creates two files:
  • A .whl file (the wheel)
  • A .tar.gz file (of the source code?)
  • Check to make sure all the files are in the package (by checking that they're in the tar file).
  • Upload a test with twine upload --repository-url https://test.pypi.org/legacy/ dist/*.
  • Check on TestPyPI to see that everything looks right.
  • Upload for real with twine upload dist/*.
• Test installation using pip install.

The example package used for this uses a different folder structure. The analogy for t_games would be to have a t_games folder within the t_games folder. The lower folder would hold all the actual code. The upper folder would hold all the other files, like t_tests and support_files. It's not clear if I need that sort of file structure to make this work.

[ichabod801]

This is the setup.py file that realpython.com used for their example:

import pathlib
from setuptools import setup

# The directory containing this file
HERE = pathlib.Path(__file__).parent

# The text of the README file
README = (HERE / "README.md").read_text()

# This call to setup() does all the work
setup(
    name="realpython-reader",
    version="1.0.0",
    description="Read the latest Real Python tutorials",
    long_description=README,
    long_description_content_type="text/markdown",
    url="https://github.com/realpython/reader",
    author="Real Python",
    author_email="office@realpython.com",
    license="MIT",
    classifiers=[
        "License :: OSI Approved :: MIT License",
        "Programming Language :: Python :: 3",
        "Programming Language :: Python :: 3.7",
    ],
    packages=["reader"],
    include_package_data=True,
    install_requires=["feedparser", "html2text"],
    entry_points={
        "console_scripts": [
            "realpython=reader.__main__:main",
        ]
    },
)

[ichabod801]

I'm seeing a couple of recommendations to try doing this with a dummy project first to make sure you understand what is going on.

[ichabod801]

Python.org also uses the same folder organization as realpython.com.

[ichabod801]

I've skimmed five or six different tutorials on this. They all use the same file structure, but none of them explicitly state it is necessary.

[ichabod801]

The first answer to this StackOverflow question says you must create a package, although the question is not on point.

[ichabod801]

I was to close this repo and move on. Putting it on PyPI does not advance that goal, and there's the off chance it could hinder it. So don't put it on PyPI and just tie the repo off.