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

Add documentation for creating python distribution to component #16

Open
sstripps1 opened this issue Mar 5, 2025 · 2 comments
Open
Labels
enhancement New feature or request

Comments

@sstripps1
Copy link
Collaborator

sstripps1 commented Mar 5, 2025

It looks like the generated README does not include the steps for creating the python distribution, ie

5. Create a Python distribution
    ```
    $ python setup.py sdist bdist_wheel
    ```
    This will create source and wheel distribution in the generated the `dist/` folder.
    See [PyPA](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project)
    for more information.

6. Test your tarball by copying it into a new environment and installing it locally:
    ```
    $ pip install {{cookiecutter.project_shortname}}-0.0.1.tar.gz

I had a customer who was confused about this, so maybe this can be added for clarity (I'm happy to open a PR but doesn't look like I'm enabled to contribute to this repo)

cc @gvwilson

@T4rk1n
Copy link
Collaborator

T4rk1n commented Mar 7, 2025

There is the just package command:

# Package the application for distribution using python wheel.
package: clean build
python -m build --wheel

It also has the modern build command, python -m build as python setup.py is not recommended anymore.

For local install, I'd recommend using pip install -e ./path-to-project, package to share.

Can fork and create a PR for contributions.

@gvwilson
Copy link
Contributor

gvwilson commented Mar 7, 2025

thanks @T4rk1n - and thanks for creating #17. @sstripps1 we will try to address both as soon as Dash 3.0 goes out.

@gvwilson gvwilson added the enhancement New feature or request label Mar 7, 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

3 participants