Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup script lacks descriptive information #10

Open
LuisAPI opened this issue Jan 23, 2025 · 0 comments
Open

Setup script lacks descriptive information #10

LuisAPI opened this issue Jan 23, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@LuisAPI
Copy link
Owner

LuisAPI commented Jan 23, 2025

The current setup.py script is missing important metadata and configuration details required for a proper PyPI release. This includes author information, description, long description, URL, dependencies, classifiers, and Python version requirements.

Current setup.py

from setuptools import setup, find_packages

setup(
    name='YouTubeWikiBot',
    version='0.1',
    packages=find_packages(where='src'),
    package_dir={'': 'src'},
)

Required Updates

  1. Author Information: Add author and author_email.
  2. Description: Add description and long_description.
  3. URL: Add url for the project homepage.
  4. Dependencies: Read dependencies from requirements.txt.
  5. Classifiers: Add appropriate classifiers.
  6. Python Version: Specify the required Python version.

Proposed setup.py

from setuptools import setup, find_packages

def read_requirements():
    with open('requirements.txt') as f:
        return f.read().splitlines()

setup(
    name='YouTubeWikiBot',
    version='0.1',
    author='Luis Imperial',
    author_email='[email protected]',
    description='A bot to create a database of the most popular creators on YouTube.',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/YouTubeWikiBot',
    packages=find_packages(where='src'),
    package_dir={'': 'src'},
    install_requires=read_requirements(),
    classifiers=[
        'Programming Language :: Python :: 3',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
    ],
    python_requires='>=3.6',
)

Steps to Reproduce

  1. Open the current setup.py file.
  2. Observe the lack of metadata and configuration details.

Expected Behavior

The setup.py script should include all necessary metadata and configuration details for a proper PyPI release.

Additional Context

Including this information will ensure the package is correctly configured for distribution on PyPI and will provide users with essential details about the project.


Please update the setup.py script accordingly.

@LuisAPI LuisAPI added the enhancement New feature or request label Jan 23, 2025
@LuisAPI LuisAPI self-assigned this Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant