Skip to main content

Package skeleton for a Python Serverless project on AWS Lambda.

Project description

PyPI GitHub Actions

Package skeleton for a Python Serverless project on AWS Lambda.


Bootstrap a new Python Serverless project in five minutes or less.


Bootstrapping a New Project

  1. Create an empty (non-initialized) repository on GitHub.

  2. Clone the master branch of this repository with

    $ git clone --single-branch new-serverless-python
    $ cd new-serverless-python

    Optionally, reset to the latest release with

    $ git reset --hard <version-tag>
  3. Run

    $ ./

    This will replace the boilerplate, delete itself, remove the git remote, remove upstream tags, and stage changes for commit.

  4. Create the required GitHub repository secrets

  5. Review, commit, and push the changes to GitHub with

    $ git diff --cached
    $ git commit -m "Replace makenew boilerplate"
    $ git remote add origin<user>/<new-serverless-python>.git
    $ git push -u origin master
  6. Ensure the GitHub action passes, then release the initial version with

    $ npm install
    $ poetry install
    $ poetry version patch
    $ make version


If you want to pull in future updates from this skeleton, you can fetch and merge in changes from this repository.

Add this as a new remote with

$ git remote rename origin upstream

and then configure your origin branch as normal.

Otherwise, add this as a new remote with

$ git remote add upstream

You can then fetch and merge changes with

$ git fetch --no-tags upstream
$ git merge upstream/master


Note that is just a template for this skeleton. The actual changes for this project are documented in the commit history and summarized under Releases.


This package is registered on the Python Package Index (PyPI) as makenew-serverless-python.

Install it with

$ poetry add makenew-serverless-python

Development and Testing


$ git clone
$ cd serverless-python
$ poetry install

Run each command below in a separate terminal window:

$ make watch

Primary development tasks are defined in the Makefile.

Source Code

The source code is hosted on GitHub. Clone the project with

$ git clone


You will need Python 3 and Poetry and Node.js with npm. To run some Serverless commands you will need Docker.

Install the development dependencies with

$ poetry install
$ npm install


Lint code with

$ make lint

Run tests with

$ make test

Run tests on changes with

$ make watch


Use the poetry version command to release a new version. Then run make version to commit and push a new git tag which will trigger a GitHub action.

Publishing may be triggered using a version workflow_dispatch on GitHub Actions.


Serverless deployment is triggered by a release repository_dispatch on GitHub Actions.

Deployment may be triggered using a release workflow_dispatch on GitHub Actions.

GitHub Actions

GitHub Actions should already be configured: this section is for reference only.

The following repository secrets must be set on GitHub Actions.

  • PYPI_API_TOKEN: API token for publishing on PyPI.

  • AWS_DEFAULT_REGION: The AWS region Serverless will deploy to.

  • AWS_ACCESS_KEY_ID: AWS access key ID.

  • AWS_SECRET_ACCESS_KEY: AWS secret access key.

  • GH_TOKEN: A personal access token that can trigger workflows.

These must be set manually.

Secrets for Optional GitHub Actions

The version and format GitHub actions require a user with write access to the repository. including access to trigger workflows. Set these additional secrets to enable the action:

  • GH_TOKEN: A personal access token for the user.

  • GIT_USER_NAME: The name to set for Git commits.

  • GIT_USER_EMAIL: The email to set for Git commits.

  • GPG_PRIVATE_KEY: The GPG private key.

  • GPG_PASSPHRASE: The GPG key passphrase.


Please submit and comment on bug reports and feature requests.

To submit a patch:

  1. Fork it (

  2. Create your feature branch (git checkout -b my-new-feature).

  3. Make changes.

  4. Commit your changes (git commit -am ‘Add some feature’).

  5. Push to the branch (git push origin my-new-feature).

  6. Create a new Pull Request.


This Serverless project is licensed under the MIT license.


This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

makenew-serverless-python-6.6.0.tar.gz (6.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page