aws / aws/chalice

Document how to distribute and import projects

Open
#190 2 comments 3 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
11.1k
Forks
1k
Avg merge
1d 22h
Merged PRs (30d)
2

Description

Creating a new project from scratch is obvious, but if an author wished to post his Chalice project for other developers to use, it's less so. I'm guessing the best practice would be:

1. Share your `app.py` for your project `foo`.
2. Instruct other developers to:
1. rtfm Chalice
2. Make a new project: `chalice new-project foo`
3. Overwrite generated `app.py` with the shared `app.py`
4. Deploy: `cd foo && chalice deploy`

Is this correct and is it what's intended? It's straightforward but perhaps indirect. Please throw a paragraph in the README.

Contributor guide

Open the contributing guide

Research direction

Start by reading the README and reviewing the proposed workflow: sharing app.py, running chalice new-project, replacing the generated app.py, and deploying with chalice deploy. Confirm the intended way to distribute and import a Chalice project, then document the approved steps in a README paragraph; done means another developer can follow them without guessing.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.