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

Scripts Inclusion in Pip Package #52

Open
CavRiley opened this issue Apr 25, 2024 · 0 comments
Open

Scripts Inclusion in Pip Package #52

CavRiley opened this issue Apr 25, 2024 · 0 comments
Assignees

Comments

@CavRiley
Copy link
Collaborator

If this feature request related to a problem? Please describe.

This feature request aims to include additional scripts in the pip package to enhance the usability of the package for end-users.

Alternatives Considered If Applicable

N/A

Rationale

Adding scripts to the pip package allows users to conveniently access command-line tools or utilities provided by the package without having to manually locate or install them separately. This enhances the user experience and streamlines the workflow for utilizing the package's functionality.

Implementation Ideas

  • Identify the scripts or command-line tools that should be included in the pip package.
  • Ensure that these scripts are properly documented and tested to meet the quality standards of the project.
  • Update the package setup script (pyproect.toml) to include the necessary configuration for including the scripts in the package distribution.
  • Consider organizing the scripts into a dedicated directory within the package structure for better organization and maintainability.
  • Update the package documentation to inform users about the available scripts and how to use them.

Additional Context

Including scripts in the pip package will make it easier for users to access and utilize the package's functionality directly from the command line. This feature aligns with the project's goal of providing a user-friendly and comprehensive solution for its users.

@CavRiley CavRiley self-assigned this Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

1 participant