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

Simplify scaffold project with option to exclude files from the template #25244

Open
dbrtly opened this issue Oct 12, 2024 · 0 comments
Open

Comments

@dbrtly
Copy link
Contributor

dbrtly commented Oct 12, 2024

What's the use case?

Starting with PEP 621 - Storing project metadata in pyproject.toml, the Python community selected pyproject.toml as a standard way of specifying project metadata. Setuptools has adopted this standard and will use the information contained in this file as an input in the build process.

The scaffold project includes pyproject.toml, setup.cfg and setup.py.
All the data in setup.cfg and setup.py can be configured in pyproject.toml.
For the quickstart, most of it is already configured in pyproject.toml.

PEP621 was formally accepted in Nov 2020.

A scaffold template with two fewer files would be simpler for new users getting started with dagster.
Have extended the idea to generically skip files from the template to enable

dagster project scaffold quickstart --skip-files setup* --skip-files test

For the record, as a matter of taste, I prefer:
dagster project scaffold quickstart --exclude setup* --exclude test

Ideas of implementation

see PR #25245

Additional information

I would like to make the code contribution

Message from the maintainers

Impacted by this issue? Give it a 👍! We factor engagement into prioritization.

@dbrtly dbrtly changed the title Simplify scaffold project by removing duplicated code Simplify scaffold project with option to exclude setup.cfg and setup.py Oct 12, 2024
@dbrtly dbrtly changed the title Simplify scaffold project with option to exclude setup.cfg and setup.py Simplify scaffold project with option to exclude files from the template Oct 12, 2024
@garethbrickman garethbrickman added the type: ergonomics developer ergonomics label Oct 14, 2024
cmpadden added a commit that referenced this issue Oct 29, 2024
…tes (#25245)

PEP 621 (Nov 2020) introduced pyproject.toml.
Setuptools is fully compatible with pyroject. 
All the config in setup.cfg and setup.py will also be in pyproject.toml
project template if this is merged.
Minimalist config to make adopting dagster easy.

## Summary & Motivation
See #25244 

## How I Tested These Changes

![image](https://github.com/user-attachments/assets/75473daa-a282-4564-93fd-db1d95cf2691)
Last time I tried the run the test suite it failed because my macbook
has an intel chipset.

## Changelog
(CLI) 
`dagster project scaffold`: Add option to create dagster projects from
templates with excluded files/filepaths
`dagster project scaffold-code-location`: Refactored to leverage
scaffold command with excludes flag. Deprecated.

---------

Co-authored-by: Colton Padden <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants