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

Implement a Quickstart CLI / Scaffolding Generator #1051

Open
jmvrbanac opened this issue May 20, 2017 · 6 comments
Open

Implement a Quickstart CLI / Scaffolding Generator #1051

jmvrbanac opened this issue May 20, 2017 · 6 comments
Labels
enhancement needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks!
Milestone

Comments

@jmvrbanac
Copy link
Member

Setting up a new Falcon API takes longer than it probably should. Also, quite a few newer contributors ask questions about how to start up and structure a new Falcon API project. While we have some documentation around this, it would be great if we make this much easier. This would be sort of like sphinx-quickstart only for Falcon.

@jmvrbanac jmvrbanac added this to the Version 1.3 milestone May 20, 2017
@jmvrbanac jmvrbanac self-assigned this May 20, 2017
@jmvrbanac jmvrbanac modified the milestones: Version 1.4, Version 1.3 Jun 26, 2017
@kgriffs
Copy link
Member

kgriffs commented Sep 30, 2017

Just a thought, but perhaps we could roll this into a "falcon-cli" that could start a development server, generate a QuickStart project template, and maybe even pull down templates from GitHub repos or something.

@kgriffs
Copy link
Member

kgriffs commented Nov 4, 2017

Just got a request for this feature via the Gitter channel, copying here for the record:

do we have a sample "manage.py" to run one-off CLI commands in falcon, similar to django or flask ?

@phoenix911
Copy link

I'm working on something similar. falacon_setup . M planning to add cli later.

@kgriffs kgriffs modified the milestones: Version 1.4, Version 2.0 Nov 21, 2017
@kgriffs kgriffs modified the milestones: Version 2.0, Version 2.2 Nov 8, 2018
@kgriffs kgriffs modified the milestones: Version 3.1, Version 3.0 May 5, 2019
@nZac nZac mentioned this issue May 5, 2019
@kgriffs
Copy link
Member

kgriffs commented May 5, 2019

Based on discussions with other members of the maintainer's team during PyCon I think we have come to a rough consensus that our first iteration on this will simply output a simple scaffolding with inline comments showing where people can plug in their favorite libraries for config, logging, DB, etc.

@kgriffs kgriffs added the needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks! label May 5, 2019
@kgriffs kgriffs changed the title Implement a Quickstart CLI Implement a Quickstart CLI / Scaffolding May 6, 2019
@kgriffs kgriffs changed the title Implement a Quickstart CLI / Scaffolding Implement a Quickstart CLI / Scaffolding Generator May 6, 2019
@kgriffs
Copy link
Member

kgriffs commented May 6, 2019

P.S. - We should also provide a basic layout suggestion for a project in the docs that mirrors whatever the CLI tool generates (see also: #1520)

@nZac
Copy link

nZac commented May 7, 2019

@phoenix911 that is cool, thanks for sharing. I noticed you organized things around Falcon concepts (hooks, controllers, middlewares) instead of app/business concepts (user, account, etc) which then contain hooks/controllers/middlewares.

Just curious if you had thoughts structuring based on app concepts?

@kgriffs kgriffs modified the milestones: Version 3.0, Version 3.1 Aug 28, 2019
@vytas7 vytas7 modified the milestones: Version 3.1, Version 3.2 Dec 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement needs contributor Comment on this issue if you'd like to volunteer to work on this. Thanks!
Projects
None yet
Development

No branches or pull requests

5 participants