Skip to content

Conversation

adam-lightning
Copy link
Contributor

@adam-lightning adam-lightning commented Jul 26, 2022

What does this PR do?

Currently when You init a new app using lightning init app <app_name> the app.py is in the module directory which impacts running app with --cloud flag (as the requirements.txt is in different dir.
Here, we move app.py up to achieve the following templated structure:

tree my-app-test
my-app-test
├── LICENSE
├── README.md
├── app.py                     # <--- now here - previously was created inside my_app_test directory 
├── my_app_test
│   ├── __init__.py
│   └── components
│       ├── component_a
│       │   ├── __init__.py
│       │   └── component_a.py
│       └── component_b
│           ├── __init__.py
│           └── component_a.py
├── requirements.txt
├── setup.py
└── tests
    ├── README.md
    ├── __init__.py
    ├── requirements.txt
    └── test_my_app_test_app.py

Fixes issues with running with --cloud flag. And standardises the folder structure.

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

cc @Borda

@github-actions github-actions bot added the app (removed) Generic label for Lightning App package label Jul 26, 2022
@adam-lightning adam-lightning self-assigned this Jul 26, 2022
@awaelchli
Copy link
Contributor

Adding an entry in the changelog would be nice if you can :)

@mergify mergify bot added the has conflicts label Aug 4, 2022
@mergify mergify bot removed the has conflicts label Aug 4, 2022
@mergify mergify bot added the ready PRs ready to be merged label Aug 4, 2022
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

@mergify mergify bot added has conflicts and removed ready PRs ready to be merged labels Aug 8, 2022
@Borda Borda added this to the app:0.6 milestone Aug 8, 2022
@mergify mergify bot added ready PRs ready to be merged and removed has conflicts ready PRs ready to be merged labels Aug 17, 2022
@mergify mergify bot added the ready PRs ready to be merged label Aug 17, 2022
@lexierule lexierule merged commit 79fc6af into master Aug 17, 2022
@lexierule lexierule deleted the fix-template-app-py-should-be-in-app-directory branch August 17, 2022 14:15
@krshrimali krshrimali mentioned this pull request Sep 16, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app (removed) Generic label for Lightning App package ready PRs ready to be merged
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants